Skip to content

Commit

Permalink
DOC: Fix blank area and remove sphinx-jinja dependency (#4611)
Browse files Browse the repository at this point in the history
  • Loading branch information
SMoraisAnsys authored May 3, 2024
2 parents bb46da2 + 321a7fc commit 9a07dfa
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 45 deletions.
19 changes: 0 additions & 19 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,6 @@ def setup(app):
"sphinx.ext.coverage",
"sphinx_copybutton",
"sphinx_design",
"sphinx_jinja",
"sphinx.ext.graphviz",
"sphinx.ext.mathjax",
"sphinx.ext.inheritance_diagram",
Expand Down Expand Up @@ -296,24 +295,6 @@ def setup(app):
# "set_plot_theme('document')"),
}

jinja_contexts = {
"main_toctree": {
"run_examples": config["run_examples"],
},
}
# def prepare_jinja_env(jinja_env) -> None:
# """
# Customize the jinja env.
#
# Notes
# -----
# See https://jinja.palletsprojects.com/en/3.0.x/api/#jinja2.Environment
# """
# jinja_env.globals["project_name"] = project
#
#
# autoapi_prepare_jinja_env = prepare_jinja_env

# -- Options for HTML output -------------------------------------------------
html_short_title = html_title = "PyAEDT"
html_theme = "ansys_sphinx_theme"
Expand Down
39 changes: 15 additions & 24 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,33 +37,24 @@ enabling straightforward and efficient automation in your workflow.
This section contains descriptions of the functions and modules included in PyAEDT.
It describes how the methods work and the parameters that can be used.

.. jinja:: main_toctree

.. grid:: 2

{% if run_examples %}
.. grid-item-card:: Examples :fa:`scroll`
:link: examples/index
:link-type: doc
.. grid-item-card:: Examples :fa:`scroll`
:link: examples/index
:link-type: doc

Explore examples that show how to use PyAEDT to perform different types of simulations.

{% endif %}
Explore examples that show how to use PyAEDT to perform different types of simulations.

.. grid-item-card:: Contribute :fa:`people-group`
:link: Getting_started/Contributing
:link-type: doc
.. grid:: 2

Learn how to contribute to the PyAEDT codebase or documentation.
.. grid-item-card:: Contribute :fa:`people-group`
:link: Getting_started/Contributing
:link-type: doc

.. jinja:: main_toctree
Learn how to contribute to the PyAEDT codebase or documentation.

.. toctree::
:hidden:
.. toctree::
:hidden:

Getting_started/index
User_guide/index
API/index
{% if run_examples %}
examples/index
{% endif %}
Getting_started/index
User_guide/index
API/index
examples/index
2 changes: 0 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,6 @@ doc = [
#"sphinx-autodoc-typehints",
"sphinx-copybutton>=0.5.0,<0.6",
"sphinx-gallery>=0.14.0,<0.17",
"sphinx-jinja>=2.0,<2.1",
#"sphinx-notfound-page",
"sphinx_design>=0.4.0,<0.6",
#"sphinxcontrib-websupport",
Expand All @@ -118,7 +117,6 @@ doc-noexamples = [
#"sphinx-notfound-page",
#"sphinxcontrib-websupport",
"sphinx_design>=0.4.0,<0.6",
"sphinx-jinja>=2.0,<2.1",
]
all = [
"imageio>=2.30.0,<2.35",
Expand Down

0 comments on commit 9a07dfa

Please sign in to comment.