Skip to content

Fix: update the docs and auto function module with update of theme package. #262

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.

Sign up for GitHub

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

Merged
merged 5 commits into from
Feb 23, 2023
Merged

Fix: update the docs and auto function module with update of theme package. #262

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
60231c0
Docs: change the multiversion docs
Revathyvenugopal162 Feb 22, 2023
ac899d3
Fix : Change the autofunction
Revathyvenugopal162 Feb 22, 2023
42195b2
DOC: exclude theme examples
jorgepiloto Feb 22, 2023
58ebe3e
Update requirements/requirements_doc.txt
RobPasMue Feb 23, 2023
5b83cb2
Update requirements/requirements_doc.txt
Revathyvenugopal162 Feb 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions doc/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,9 +152,9 @@
"packaging/diag/*",
"packaging/code/*",
"how-to/diag/*",
"how-to/api/ansys_sphinx_theme.samples.Complex.abs.rst",
"how-to/api/ansys_sphinx_theme.samples.Complex.imag.rst",
"how-to/api/ansys_sphinx_theme.samples.Complex.real.rst",
"how-to/api/ansys_sphinx_theme.examples.samples.Complex.abs.rst",
"how-to/api/ansys_sphinx_theme.examples.samples.Complex.imag.rst",
"how-to/api/ansys_sphinx_theme.examples.samples.Complex.real.rst",
]

# Fix excessive margins in mermaid output.
Expand Down
4 changes: 2 additions & 2 deletions doc/source/doc-style/docstrings.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -297,11 +297,11 @@ To include the docstring of a function within Sphinx, you use the

.. code::

.. autofunction:: ansys_sphinx_theme.sample_func.func
.. autofunction:: ansys_sphinx_theme.examples.sample_func.func

This directive renders the sample function as:

.. autofunction:: ansys_sphinx_theme.sample_func.func
.. autofunction:: ansys_sphinx_theme.examples.sample_func.func

.. _numpydoc: https://numpydoc.readthedocs.io/en/latest/format.html
.. _googledoc: https://google.github.io/styleguide/
21 changes: 10 additions & 11 deletions doc/source/how-to/documenting.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -308,12 +308,12 @@ For simple classes, use the ``autoclass`` directive:

.. code-block:: rst

.. autoclass:: ansys_sphinx_theme.samples.ExampleClass
.. autoclass:: ansys_sphinx_theme.examples.samples.ExampleClass
:members:

.. tab-item:: Rendered Doc

.. autoclass:: ansys_sphinx_theme.samples.ExampleClass
.. autoclass:: ansys_sphinx_theme.examples.samples.ExampleClass
:members:


Expand All @@ -326,24 +326,24 @@ For complex classes with many methods, use the

.. code-block:: rst

.. autoclass:: ansys_sphinx_theme.samples.Complex
.. autoclass:: ansys_sphinx_theme.examples.samples.Complex

.. autosummary::
:toctree: api/

ansys_sphinx_theme.samples.Complex.real
ansys_sphinx_theme.samples.Complex.imag
ansys_sphinx_theme.samples.Complex.abs
ansys_sphinx_theme.examples.samples.Complex.real
ansys_sphinx_theme.examples.samples.Complex.imag
ansys_sphinx_theme.examples.samples.Complex.abs

.. tab-item:: Rendered Doc

.. autoclass:: ansys_sphinx_theme.samples.Complex
.. autoclass:: ansys_sphinx_theme.examples.samples.Complex

.. autosummary::

ansys_sphinx_theme.samples.Complex.real
ansys_sphinx_theme.samples.Complex.imag
ansys_sphinx_theme.samples.Complex.abs
ansys_sphinx_theme.examples.samples.Complex.real
ansys_sphinx_theme.examples.samples.Complex.imag
ansys_sphinx_theme.examples.samples.Complex.abs

When you use the ``autosummary`` directive, each class has its own dedicated page,
and each method and attribute in that class also has its own page.
Expand Down Expand Up @@ -491,7 +491,6 @@ Follow these steps to enable multi-version documentation in your project:
"json_url": f"https://{cname}/release/versions.json",
"version_match": get_version_match(__version__),
},
"navbar_end": ["version-switcher", "theme-switcher", "navbar-icon-links"],
...
}

Expand Down
2 changes: 1 addition & 1 deletion requirements/requirements_doc.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Sphinx==5.3.0
ansys-sphinx-theme==0.8.2
ansys-sphinx-theme==0.9.3
sphinx-copybutton==0.5.1
sphinx_toolbox==3.4.0
sphinx_design==0.3.0
Expand Down