Atualiza documentação do projeto

matheusvb3 · Aug 19, 2024 · e272aaf · e272aaf
1 parent 942e1db
commit e272aaf
Show file tree

Hide file tree

Showing 5 changed files with 37 additions and 6 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -1,6 +1,8 @@
 import os
 import sys
 
+sys.path.insert(0, os.path.abspath('../src')) # Informa onde está o diretório contendo o código fonte
+
 # Configuration file for the Sphinx documentation builder.
 #
 # For the full list of built-in configuration values, see the documentation:
@@ -19,7 +21,7 @@
 
 extensions = [
     'sphinx.ext.autodoc', # Usado para que o Sphinx faça parse das docstrings nos arquivos de código fonte do projeto
-    'myst_parser'
+    'sphinx.ext.viewcode' # Usado para que seja incluído um botão para mostrar o código fonte de uma função na documentação
 ]
 
 templates_path = ['_templates']
@@ -33,4 +35,4 @@
 html_theme = 'alabaster'
 html_static_path = ['_static']
 
-sys.path.insert(0, os.path.abspath('../src')) # Informa onde está o diretório contendo o código fonte
+master_doc = 'index' # Por padrão o Sphinx espera que a página inicial da documentação seja "contents.html", mas como iremos utilizar "index.html" temos que especificar isto
diff --git a/docs/conversor.rst b/docs/conversor.rst
@@ -0,0 +1,22 @@
+conversor package
+=================
+
+Submodules
+----------
+
+conversor.conversor module
+--------------------------
+
+.. automodule:: conversor.conversor
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: conversor
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/index.rst b/docs/index.rst
@@ -3,14 +3,14 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to Conversor's documentation!
+Documentação do projeto Conversor
 =====================================
 
 .. toctree::
    :maxdepth: 2
-   :caption: Contents:
-
+   :caption: Conteúdo:
 
+   conversor
 
 Indices and tables
 ==================

diff --git a/docs/modules.rst b/docs/modules.rst
@@ -0,0 +1,7 @@
+src
+===
+
+.. toctree::
+   :maxdepth: 4
+
+   conversor
diff --git a/pyproject.toml b/pyproject.toml
@@ -21,7 +21,7 @@ dependencies = [ # Aqui estão as dependências para quem for trabalhar com o de
     "ruff",
     "mypy",
     "sphinx",
-    "myst-parser" # Para usar Markdown com o Sphinx
+    "myst-parser" # Para usar Markdown com o Sphinx. Neste projeto não será usado, mas vou deixar incluso apneas por acaso.
 ]
 
 [tool.hatch.version]