Package: emdemor-app-template
ModificaçõesAltere o nome da pastaemdemor_app_templatepara o nome do seu App e desenvolva seu código ali. Vou citar como exemplo um app fictícioemmapp.No arquivoenvironment.ymlaltere o nome do ambiente conda para o que seja de maior conveniência. Por exemplo, pode-se usaremmapp.Configure o arquivoLICENSEde acordo com a licensa que escolher.No arquivo Makefile, substituaemdemor_app_templatenas linhas 19 e 24 (dentro das regras clear e uninstall) para o nome de seu app (no nosso caso,emmapp)No arquivopyproject.toml, Substituaemdemor_app_templatepelo nome de seu app nas linhas 6 (campo "name" dentro de [project]), 28 (campo "version" dentro de [tool.setuptools.dynamic]) e 32 (campo onde você define o comando para rodar o app. Escolha o comando que deseja usar.)No arquivodocs/source/conf.py, substitua o app name nas linhas 9 (dentro dosys.path.insert) e 14 (nome do projeto). Aproveite para configurar as informações de autor e data.Escreva a introdução da sua documentação no arquivodocs/source/intro.rstPara cada modulo na pastaemmapp(no seu caso, será o nome de seu app), crie uma arquivo tipo RST dentro de_files/_modulescom o nome do modulo. Por exemplo, para o móduloemmapp.utils, deve-se criar o arquivo_files/_modules/utils.rst. Dentro, deverá ter o seguinte código{{nome do modulo}}
===================

.. automodule:: {{nome do modulo}}
   :members:Para cada submodulo na pastaemmapp(no seu caso, será o nome de seu app), crie uma pasta dentro de_files/_modulescom o nome do modulo e um arquivo tipo RST dentro dessa pasta para cada submodulo. Por exemplo, para do móduloemmapp/mymodule/hello, deve-se criar a pasta_files/_modules/mymodule, e dentro, o arquivo_files/_modules/mymodule/hello.rst. Nesse arquivo, deverá ter o seguinte código{{nome do submodulo}}
===================

.. automodule:: {{nome do modulo}}.{{nome do submodulo}}
   :members:Dentro de_files/_usage, edite o arquivogetting_started.rste quaisquer outros arquivos que adicionar. Lembre-se que para cada arquivo novo emdocs/source/_files/_usage, deve-se também referenciá-lo emdocs/source/usage.rstDetalhes sobre a documentaçãoInstale sphinxpipinstallsphinxCrie e entre na pasta docs e rode sphinx-quickstartmkdirdocscddocs
sphinx-quickstartPreencha as informações>Separarosdiretóriosdeorigemecompilação(y/n)[n]:y
>Nomedoprojeto:TemplatedePython
>Nome(s)deautor(es):A.U.Thor
>Lançamentodoprojeto[]:2022-12-31
>Idiomadoprojeto[en]:enApós isso, teremos duas pastas dentro de docs. A pasta source vai ser onde vamos trabalhar para gerar documentação. A pasta build será onde a documentação estará.Editar o endereço do seus modulos (no template, é a pasta src) em relação ao arquivodocs/source/conf.py. No nosso caso, será:importosimportsyssys.path.insert(0,os.path.abspath("../../src"))Adicione extensões. No arquivodocs/source/conf.py, onde está# Add any Sphinx extension module names here, as strings. They can be# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom# ones.extensions=[]Substitua por:# Add any Sphinx extension module names here, as strings. They can be# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom# ones.extensions=["sphinx.ext.autodoc","sphinx.ext.intersphinx","sphinx.ext.autodoc","sphinx.ext.mathjax","sphinx.ext.viewcode","sphinx.ext.napoleon",]Altere o thema html do arquivo# The theme to use for HTML and HTML Help pages.  See the documentation for# a list of builtin themes.#html_theme="sphinx_rtd_theme"Adicione logo, favicon e estilos css à sua página. Para isso, adicione todos os arquivos dentro dedocs/source/_static. Dentro do arquivodocs/source/conf.py, adicione as seguintes linhas:# Add any paths that contain custom static files (such as style sheets) here,# relative to this directory. They are copied after the builtin static files,# so a file named "default.css" will overwrite the builtin "default.css".html_static_path=["_static"]html_logo="_static/logo.png"html_css_files=["custom-theme.css"]html_favicon="_static/favicon.ico"html_theme_options={"logo_only":True,"display_version":False,}Dentro da pasta docs, rode:makehtmlA documentação estará emdocs/build/html