-
Notifications
You must be signed in to change notification settings - Fork 20
Better Sphinx docs: example improvement on logic #441
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.
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
base: master
Are you sure you want to change the base?
Changes from all commits
16b227b
d751e8a
85ffcc3
e660873
38cc008
61c9fad
45f7f5a
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -14,3 +14,4 @@ cmake-build-debug/ | |
| .cache/ | ||
| .DS_Store | ||
| .venv/ | ||
| doc/source/api/generated/ | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| {{ objname | escape | underline }} | ||
|
|
||
| .. currentmodule:: {{ module }} | ||
|
|
||
| .. autoclass:: {{ objname }} | ||
| :members: | ||
| :undoc-members: | ||
| :inherited-members: | ||
| :show-inheritance: |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| {{ objname | escape | underline }} | ||
|
|
||
| .. currentmodule:: {{ module }} | ||
|
|
||
| .. auto{{ objtype }}:: {{ objname }} |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| {#- Only list the members that belong to this module (see filter_api_members in conf.py) -#} | ||
| {%- set attributes = filter_api_members(fullname, attributes) -%} | ||
| {%- set functions = filter_api_members(fullname, functions) -%} | ||
| {%- set classes = filter_api_members(fullname, classes) -%} | ||
| {%- set exceptions = filter_api_members(fullname, exceptions) -%} | ||
| {{ fullname | escape | underline}} | ||
|
|
||
| .. automodule:: {{ fullname }} | ||
|
|
||
| {% block attributes %} | ||
| {%- if attributes %} | ||
| .. rubric:: {{ _('Module Attributes') }} | ||
|
|
||
| .. autosummary:: | ||
| :toctree: | ||
| {% for item in attributes %} | ||
| {{ item }} | ||
| {%- endfor %} | ||
| {% endif %} | ||
| {%- endblock %} | ||
|
|
||
| {%- block functions %} | ||
| {%- if functions %} | ||
| .. rubric:: {{ _('Functions') }} | ||
|
|
||
| .. autosummary:: | ||
| :toctree: | ||
| {% for item in functions %} | ||
| {{ item }} | ||
| {%- endfor %} | ||
| {% endif %} | ||
| {%- endblock %} | ||
|
|
||
| {%- block classes %} | ||
| {%- if classes %} | ||
| .. rubric:: {{ _('Classes') }} | ||
|
|
||
| .. autosummary:: | ||
| :toctree: | ||
| :template: autosummary/class.rst | ||
| {% for item in classes %} | ||
| {{ item }} | ||
| {%- endfor %} | ||
| {% endif %} | ||
| {%- endblock %} | ||
|
|
||
| {%- block exceptions %} | ||
| {%- if exceptions %} | ||
| .. rubric:: {{ _('Exceptions') }} | ||
|
|
||
| .. autosummary:: | ||
| :toctree: | ||
| :template: autosummary/class.rst | ||
| {% for item in exceptions %} | ||
| {{ item }} | ||
| {%- endfor %} | ||
| {% endif %} | ||
| {%- endblock %} |
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this where the api doc is generated? I thought it would be in a separate
builddirectory as before.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is where the
rstfiles generated bytoctreeare, this is different from the generated HTML which is inbuild. So this is the conventional way to do this.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should we call it api/.generated/ then?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Probably not, because this is the public link to the page (e.g. api/generated/stormpy.logic.BinaryPathFormula.html)