diff --git a/docs/source/_templates/breadcrumbs.html b/docs/source/_templates/breadcrumbs.html new file mode 100644 index 00000000..167d3a25 --- /dev/null +++ b/docs/source/_templates/breadcrumbs.html @@ -0,0 +1,15 @@ + + +{%- extends "sphinx_rtd_theme/breadcrumbs.html" %} + +{% block breadcrumbs_aside %} +{% if not meta or meta.get('github_url') != 'hide' %} +{{ super() }} +{% endif %} +{% endblock %} diff --git a/docs/source/_templates/custom-attribute-template.rst b/docs/source/_templates/custom-attribute-template.rst index dcf82c1e..9bad224a 100644 --- a/docs/source/_templates/custom-attribute-template.rst +++ b/docs/source/_templates/custom-attribute-template.rst @@ -1,3 +1,5 @@ +:github_url: hide + {{ name | escape | underline}} .. currentmodule:: {{ module }} diff --git a/docs/source/_templates/custom-class-template.rst b/docs/source/_templates/custom-class-template.rst index cc0f7010..c03f2368 100644 --- a/docs/source/_templates/custom-class-template.rst +++ b/docs/source/_templates/custom-class-template.rst @@ -7,6 +7,7 @@ and https://sphinx-autosummary-recursion.readthedocs.io/en/latest/index.html +:github_url: hide {{ name | escape | underline}} @@ -14,11 +15,11 @@ .. autoclass:: {{ objname }} :members: - + {% block methods %} {% if methods %} .. rubric:: {{ _('Methods') }} - + .. autosummary:: :template: custom-method-template.rst :nosignatures: @@ -29,11 +30,11 @@ {%- endfor %} {% endif %} {% endblock %} - + {% block attributes %} {% if attributes %} .. rubric:: {{ _('Attributes') }} - + .. autosummary:: :template: custom-attribute-template.rst :nosignatures: diff --git a/docs/source/_templates/custom-function-template.rst b/docs/source/_templates/custom-function-template.rst index 5ffed09e..2db8a04a 100644 --- a/docs/source/_templates/custom-function-template.rst +++ b/docs/source/_templates/custom-function-template.rst @@ -1,3 +1,5 @@ +:github_url: hide + {{ name | escape | underline}} .. currentmodule:: {{ module }} diff --git a/docs/source/_templates/custom-method-template.rst b/docs/source/_templates/custom-method-template.rst index 306d2aab..d1c60430 100644 --- a/docs/source/_templates/custom-method-template.rst +++ b/docs/source/_templates/custom-method-template.rst @@ -1,3 +1,5 @@ +:github_url: hide + {{ name | escape | underline}} .. currentmodule:: {{ module }} diff --git a/docs/source/_templates/custom-module-template.rst b/docs/source/_templates/custom-module-template.rst index f8b599d9..42eb5e7d 100644 --- a/docs/source/_templates/custom-module-template.rst +++ b/docs/source/_templates/custom-module-template.rst @@ -7,15 +7,16 @@ and https://sphinx-autosummary-recursion.readthedocs.io/en/latest/index.html +:github_url: hide {{ name | escape | underline}} .. automodule:: {{ fullname }} - + {% block attributes %} {% if attributes %} .. rubric:: {{ _('Module Attributes') }} - + .. autosummary:: :toctree: :template: custom-attribute-template.rst @@ -25,11 +26,11 @@ {%- endfor %} {% endif %} {% endblock %} - + {% block functions %} {% if functions %} .. rubric:: {{ _('Functions') }} - + .. autosummary:: :toctree: :template: custom-function-template.rst @@ -39,11 +40,11 @@ {%- endfor %} {% endif %} {% endblock %} - + {% block classes %} {% if classes %} .. rubric:: {{ _('Classes') }} - + .. autosummary:: :toctree: :template: custom-class-template.rst @@ -53,11 +54,11 @@ {%- endfor %} {% endif %} {% endblock %} - + {% block exceptions %} {% if exceptions %} .. rubric:: {{ _('Exceptions') }} - + .. autosummary:: :toctree: :nosignatures: diff --git a/docs/source/conf.py b/docs/source/conf.py index 15fe7ded..5fc3e554 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -302,11 +302,11 @@ # If True, the reStructuredText sources are included in the HTML build # as _sources/name. -html_copy_source = False +html_copy_source = True # If True (and html_copy_source is True as well), links to the # reStructuredText sources will be added to the sidebar. -html_show_sourcelink = False +html_show_sourcelink = True # If nonempty, an OpenSearch description file will be output, and all # pages will contain a tag referring to it. the value of this