LCPQ/dft_tools
3
0
Fork 0
mirror of https://github.com/triqs/dft_tools synced 2024-12-22 20:34:38 +01:00
Code Issues Releases Wiki Activity

properly load module and add toctree for class generation

Browse Source
This commit is contained in:
Alexander Hampel 2022-02-16 14:49:35 -05:00 committed by Nils Wentzell
parent d9c66bf77f
commit 8362b69e28
4 changed files with 6 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/CMakeLists.txt
View File

@ -56,7 +56,7 @@ endif()
add_custom_target(${PROJECT_NAME}_docs_sphinx ALL) add_custom_target(${PROJECT_NAME}_docs_sphinx ALL)
add_custom_command( add_custom_command(
TARGET ${PROJECT_NAME}_docs_sphinx 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) option(Sphinx_Only "When building the documentation, skip the Python Modules and the generation of C++ Api and example outputs" OFF)

9
doc/_templates/autosummary_class_template.rst vendored
View File

@ -1,19 +1,15 @@
{{ fullname | escape | underline}} {{ fullname | escape | underline }}
.. currentmodule:: {{ module }} .. currentmodule:: {{ module }}
.. autoclass:: {{ objname }} .. autoclass:: {{ objname }}
:members:
:show-inheritance:
:inherited-members:
{% block methods %} {% block methods %}
.. automethod:: __init__
{% if methods %} {% if methods %}
.. rubric:: {{ _('Methods') }} .. rubric:: {{ _('Methods') }}
.. autosummary:: .. autosummary::
:toctree:
{% for item in methods %} {% for item in methods %}
~{{ name }}.{{ item }} ~{{ name }}.{{ item }}
{%- endfor %} {%- endfor %}
@ -25,6 +21,7 @@
.. rubric:: {{ _('Attributes') }} .. rubric:: {{ _('Attributes') }}
.. autosummary:: .. autosummary::
:toctree:
{% for item in attributes %} {% for item in attributes %}
~{{ name }}.{{ item }} ~{{ name }}.{{ item }}
{%- endfor %} {%- endfor %}

2
doc/conf.py.in
View File

@ -73,7 +73,7 @@ html_theme_options = {
# Toc options # Toc options
'collapse_navigation': False, 'collapse_navigation': False,
'sticky_navigation': True, 'sticky_navigation': True,
'navigation_depth': 4, 'navigation_depth': 5,
'includehidden': True, 'includehidden': True,
'titles_only': False 'titles_only': False
} }

2
doc/documentation.rst
View File

@ -26,4 +26,4 @@ Python reference manual
:template: autosummary_module_template.rst :template: autosummary_module_template.rst
:recursive: :recursive:
app4triqs_module app4triqs