Skip to content

Commit

Permalink
fix: examples indentation (#339)
Browse files Browse the repository at this point in the history
  • Loading branch information
jorgepiloto authored and Revathyvenugopal162 committed Feb 15, 2024
1 parent 0f69d48 commit e02caf0
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
8 changes: 4 additions & 4 deletions doc/source/examples/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,20 +10,20 @@ This show how the different extensions get rendered in ansys-sphinx-theme. This
:link: sphinx-design
:link-type: ref

Examples of the sphinx design rendered using the `ansys-sphinx-theme`.
Examples of the sphinx design rendered using the `ansys-sphinx-theme`.

.. grid-item::
.. card:: Table
:link: table
:link-type: ref

Examples of tables with JavaScript and RST rendered using the `ansys-sphinx-theme`.
It also recommends improving documentation with RST.
Examples of tables with JavaScript and RST rendered using the `ansys-sphinx-theme`.
It also recommends improving documentation with RST.


.. toctree::
:hidden:
:maxdepth: 2

sphinx-design
table
table
6 changes: 3 additions & 3 deletions doc/source/examples/sphinx-design.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ please refer `sphinx design <https://sphinx-design.readthedocs.io/en/latest/inde
{{ title[0].upper() }}{{ title[1:] }}
{{ '~' * (title | length) }}

.. literalinclude:: sphinx_examples/{{ filename }}
:language: rst
.. literalinclude:: sphinx_examples/{{ filename }}
:language: rst

This directive renders as follows:

.. include:: sphinx_examples/{{ filename }}
.. include:: sphinx_examples/{{ filename }}

{% endfor %}
2 changes: 1 addition & 1 deletion tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,4 @@ commands =
description = Check if documentation generates properly
extras = doc
commands =
sphinx-build -d "{toxworkdir}/doc_doctree" doc/source "{toxworkdir}/doc_out" --color -vW -bhtml
sphinx-build doc/source "{toxinidir}/doc/_build/html" --color -vW -bhtml

0 comments on commit e02caf0

Please sign in to comment.