Skip to content

Commit

Permalink
Add static and templates
Browse files Browse the repository at this point in the history
  • Loading branch information
ngc436 committed Jul 5, 2023
1 parent 2ebf412 commit e85ed1c
Show file tree
Hide file tree
Showing 6 changed files with 105 additions and 1 deletion.
13 changes: 13 additions & 0 deletions docs/_static/style.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
.wy-nav-content {
max-width: none;
}

.rst-content code.xref {
/* !important prevents the common CSS stylesheets from overriding
this as on RTD they are loaded after this stylesheet */
color: #E74C3C
}

html.writer-html4 .rst-content dl:not(.docutils) dl:not(.field-list)>dt, html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) dl:not(.field-list)>dt {
border-left-color: rgb(9, 183, 14)
}
14 changes: 14 additions & 0 deletions docs/_templates/autosummary/class.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
.. role:: hidden
:class: hidden-section
.. currentmodule:: {{ module }}


{{ name | underline}}

.. autoclass:: {{ name }}
:members:


..
autogenerated from source/_templates/autosummary/class.rst
note it does not have :inherited-members:
48 changes: 48 additions & 0 deletions docs/_templates/autosummary/module.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
.. role:: hidden
:class: hidden-section

{{ name | underline }}

.. automodule:: {{ fullname }}

{% block classes %}
{% if classes %}
.. rubric:: {{ _('Classes') }}

.. autosummary::
:toctree: generated
:nosignatures:
:template: classtemplate.rst
{% for item in classes %}
{{ item }}
{%- endfor %}
{% endif %}
{% endblock %}

{% block functions %}
{% if functions %}
.. rubric:: {{ _('Functions') }}

.. autosummary::
:toctree: generated
:nosignatures:
:template: functiontemplate.rst
{% for item in functions %}
{{ item }}
{%- endfor %}
{% endif %}
{% endblock %}


{% block modules %}
{% if modules %}
.. rubric:: {{ _('Modules') }}

.. autosummary::
:toctree:
:recursive:
{% for item in modules %}
{{ item }}
{%- endfor %}
{% endif %}
{% endblock %}
14 changes: 14 additions & 0 deletions docs/_templates/classtemplate.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
.. role:: hidden
:class: hidden-section
.. currentmodule:: {{ module }}


{{ name | underline }}

.. autoclass:: {{ name }}
:members:


..
autogenerated from source/_templates/classtemplate.rst
note it does not have :inherited-members:
11 changes: 11 additions & 0 deletions docs/_templates/functiontemplate.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
.. role:: hidden
:class: hidden-section
.. currentmodule:: {{ module }}

{{ name | underline }}

.. autofunction:: {{ fullname }}

..
autogenerated from source/_templates/functiontemplate.rst
note it does not have :inherited-members:
6 changes: 5 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@
import sys


LIB_PATH = os.path.join(os.path.dirname(__file__))
CURR_PATH = os.path.abspath(os.path.dirname(__file__))
LIB_PATH = os.path.join(CURR_PATH, os.path.pardir)
print(LIB_PATH)
sys.path.insert(0, LIB_PATH)

Expand Down Expand Up @@ -50,4 +51,7 @@

html_static_path = ['_static']

# Autosummary true if you want to generate it from very beginning
autosummary_generate = True

set_type_checking_flag = True

0 comments on commit e85ed1c

Please sign in to comment.