From 60231c092560c0c204d7462ac12c0e1ff5a27d4d Mon Sep 17 00:00:00 2001 From: Revathyvenugopal162 Date: Wed, 22 Feb 2023 17:28:08 +0100 Subject: [PATCH 1/5] Docs: change the multiversion docs --- doc/source/how-to/documenting.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/doc/source/how-to/documenting.rst b/doc/source/how-to/documenting.rst index 760f13901..1bdc786c9 100644 --- a/doc/source/how-to/documenting.rst +++ b/doc/source/how-to/documenting.rst @@ -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"], ... } From ac899d363120e06f13b136d047c3b6caffd1fd1f Mon Sep 17 00:00:00 2001 From: Revathyvenugopal162 Date: Wed, 22 Feb 2023 17:34:46 +0100 Subject: [PATCH 2/5] Fix : Change the autofunction --- doc/source/doc-style/docstrings.rst | 4 ++-- doc/source/how-to/documenting.rst | 20 ++++++++++---------- requirements/requirements_doc.txt | 2 +- 3 files changed, 13 insertions(+), 13 deletions(-) diff --git a/doc/source/doc-style/docstrings.rst b/doc/source/doc-style/docstrings.rst index 38b26f723..6e8df797d 100644 --- a/doc/source/doc-style/docstrings.rst +++ b/doc/source/doc-style/docstrings.rst @@ -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/ diff --git a/doc/source/how-to/documenting.rst b/doc/source/how-to/documenting.rst index 1bdc786c9..76190fae0 100644 --- a/doc/source/how-to/documenting.rst +++ b/doc/source/how-to/documenting.rst @@ -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: @@ -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. diff --git a/requirements/requirements_doc.txt b/requirements/requirements_doc.txt index cc77094c8..99290c1dd 100644 --- a/requirements/requirements_doc.txt +++ b/requirements/requirements_doc.txt @@ -1,5 +1,5 @@ Sphinx==5.3.0 -ansys-sphinx-theme==0.8.2 +ansys-sphinx-theme==0.9.1 sphinx-copybutton==0.5.1 sphinx_toolbox==3.4.0 sphinx_design==0.3.0 From 42195b25e649779910f7fe270c51c0d3da8c1e98 Mon Sep 17 00:00:00 2001 From: Jorge Martinez Date: Wed, 22 Feb 2023 23:09:16 +0100 Subject: [PATCH 3/5] DOC: exclude theme examples --- doc/source/conf.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 945f5a005..6bf46304c 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -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. From 58ebe3ebd41b1cde4cf6ee05051538d5a5cdd8f5 Mon Sep 17 00:00:00 2001 From: Roberto Pastor Muela <37798125+RobPasMue@users.noreply.github.com> Date: Thu, 23 Feb 2023 07:54:39 +0100 Subject: [PATCH 4/5] Update requirements/requirements_doc.txt --- requirements/requirements_doc.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements/requirements_doc.txt b/requirements/requirements_doc.txt index 99290c1dd..70d031fb4 100644 --- a/requirements/requirements_doc.txt +++ b/requirements/requirements_doc.txt @@ -1,5 +1,5 @@ Sphinx==5.3.0 -ansys-sphinx-theme==0.9.1 +ansys-sphinx-theme==0.9.2 sphinx-copybutton==0.5.1 sphinx_toolbox==3.4.0 sphinx_design==0.3.0 From 5b83cb20b0a62d25bd87370299da7a2331f3cbc0 Mon Sep 17 00:00:00 2001 From: Revathy Venugopal <104772255+Revathyvenugopal162@users.noreply.github.com> Date: Thu, 23 Feb 2023 09:29:47 +0100 Subject: [PATCH 5/5] Update requirements/requirements_doc.txt --- requirements/requirements_doc.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements/requirements_doc.txt b/requirements/requirements_doc.txt index 70d031fb4..e9b08c03c 100644 --- a/requirements/requirements_doc.txt +++ b/requirements/requirements_doc.txt @@ -1,5 +1,5 @@ Sphinx==5.3.0 -ansys-sphinx-theme==0.9.2 +ansys-sphinx-theme==0.9.3 sphinx-copybutton==0.5.1 sphinx_toolbox==3.4.0 sphinx_design==0.3.0