mirror of
https://github.com/triqs/dft_tools
synced 2024-12-22 12:23:41 +01:00
properly load module and add toctree for class generation
This commit is contained in:
parent
d9c66bf77f
commit
8362b69e28
@ -56,7 +56,7 @@ endif()
|
||||
add_custom_target(${PROJECT_NAME}_docs_sphinx ALL)
|
||||
add_custom_command(
|
||||
TARGET ${PROJECT_NAME}_docs_sphinx
|
||||
COMMAND PYTHONPATH=${PROJECT_BINARY_DIR}/python/${PROJECT_NAME}:${PROJECT_BINARY_DIR}/python:$ENV{PYTHONPATH} ${SPHINXBUILD_EXECUTABLE} -c . -b html ${CMAKE_CURRENT_SOURCE_DIR} html
|
||||
COMMAND PYTHONPATH=${PROJECT_BINARY_DIR}/python:$ENV{PYTHONPATH} ${SPHINXBUILD_EXECUTABLE} -j auto -c . -b html ${CMAKE_CURRENT_SOURCE_DIR} html
|
||||
)
|
||||
|
||||
option(Sphinx_Only "When building the documentation, skip the Python Modules and the generation of C++ Api and example outputs" OFF)
|
||||
|
@ -3,17 +3,13 @@
|
||||
.. currentmodule:: {{ module }}
|
||||
|
||||
.. autoclass:: {{ objname }}
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:inherited-members:
|
||||
|
||||
{% block methods %}
|
||||
.. automethod:: __init__
|
||||
|
||||
{% if methods %}
|
||||
.. rubric:: {{ _('Methods') }}
|
||||
|
||||
.. autosummary::
|
||||
:toctree:
|
||||
{% for item in methods %}
|
||||
~{{ name }}.{{ item }}
|
||||
{%- endfor %}
|
||||
@ -25,6 +21,7 @@
|
||||
.. rubric:: {{ _('Attributes') }}
|
||||
|
||||
.. autosummary::
|
||||
:toctree:
|
||||
{% for item in attributes %}
|
||||
~{{ name }}.{{ item }}
|
||||
{%- endfor %}
|
||||
|
@ -73,7 +73,7 @@ html_theme_options = {
|
||||
# Toc options
|
||||
'collapse_navigation': False,
|
||||
'sticky_navigation': True,
|
||||
'navigation_depth': 4,
|
||||
'navigation_depth': 5,
|
||||
'includehidden': True,
|
||||
'titles_only': False
|
||||
}
|
||||
|
@ -26,4 +26,4 @@ Python reference manual
|
||||
:template: autosummary_module_template.rst
|
||||
:recursive:
|
||||
|
||||
app4triqs_module
|
||||
app4triqs
|
||||
|
Loading…
Reference in New Issue
Block a user