Skip to content

feat: add support for autodoc generation in cli #330

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

feat: add support for autodoc generation in cli #330

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/backend_reference.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Manages the installation and versioning of hamlet engines
Engine
_______

.. automodule:: hamlet.backend.engine.engine
.. automodule:: hamlet.backend.engine.engine
:members:

Engine Part
Expand Down
6 changes: 5 additions & 1 deletion docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,11 @@
extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.intersphinx",
"sphinx_click"
"sphinx_click",
"sphinx_markdown_builder"
]
exclude_patterns = [
'build/*'
]
autodoc_typehints = "description"
intersphinx_mapping = {"python": ("https://docs.python.org/3/", None)}
2 changes: 1 addition & 1 deletion docs/config_files.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ The config file is the default configuration file to use when configuring hamlet

The following sections are supported in the config file

.. autoclass:: hamlet.command.common.config.ConfigSchema
.. autoclass:: hamlet.command.common.config.ConfigSchema
:members:

engine
Expand Down
2 changes: 1 addition & 1 deletion setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@
# Docs
"Sphinx",
"sphinx-markdown-builder",
"sphinx-click",
"sphinx-click @ git+https://github.com/hamlet-io/sphinx-click@9f9ff310864e356624fad73a7f9e9c85468ce435",
],
},
include_package_data=True,
Expand Down