Skip to content
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

fix: examples indentation #339

Merged
merged 1 commit into from
Jan 31, 2024
Merged

fix: examples indentation #339

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions doc/source/examples/index.rst
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
Loading