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.

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 general details: typo, syntax... #91

Merged
merged 1 commit into from
Aug 9, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions doc/source/404_page.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Because Sphinx does not create a 404 page by default, you can use the
`sphinx-notfound-page
<https://sphinx-notfound-page.readthedocs.io/en/latest/index.html>`_ extension
for 404 pages. While originally developed for use by on `Read the Docs <https://readthedocs.org/>`_,
for 404 pages. While originally developed to be used with `Read the Docs <https://readthedocs.org/>`_,
this extension can be used in other hosting services. For more
information, see the extension's `documentation <https://sphinx-notfound-page.readthedocs.io/en/latest/how-it-works.html>`_.

Expand Down Expand Up @@ -56,7 +56,7 @@ Custom 404 page
---------------
To create a custom 404 page for your project, start by creating a ``404.rst``
file next to the ``conf.py`` file. Make sure you include the ``:orphan:`` attribute
at the top of this ``404.rst`` file to suppress the the spurious ``document isn't
at the top of this ``404.rst`` file to suppress the spurious ``document isn't
included in any toctree`` Sphinx warning.

.. code-block:: rst
Expand Down
2 changes: 0 additions & 2 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
Ansys Sphinx theme documentation |version|
==========================================

..
Simply reuse the root readme

.. include:: ../../README.rst

Expand Down
6 changes: 3 additions & 3 deletions doc/source/options.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Here is how you use ``html_theme_options`` to add breadcrumbs to the Ansys Sphin
When you are on the module homepage, the breadcrumb displays the homepage
title. However, this title is not accessible to Sphinx from other
documentation pages. Therefore, the ``html_short_title`` is used as the display
text for the bread crumb on the documentation homepage. To ensure a consistent user
text for the breadcrumb on the documentation homepage. To ensure a consistent user
PipKat marked this conversation as resolved.
Show resolved Hide resolved
experience, you should ensure that the ``html_short_title`` (or optionally
``html_title`` if ``html_short_title`` is not used) is set to the same value as
the title of the ``index.rst`` page. For example:
Expand All @@ -46,7 +46,7 @@ use ``|version|``.

Customize icons
~~~~~~~~~~~~~~~
The Ansys Sphinx themme allows you to control what icons are shown in the
The Ansys Sphinx theme allows you to control what icons are shown in the
navigation bar.

- Conprehensive information on customizing icons is available in
Expand All @@ -62,7 +62,7 @@ Add icons
---------
To add icons to the navigation bar, in ``html_theme_options``, you add them to the ``icon_links``
dictionary. For each icon to add, you must specify its ``name``, the associated ``url``,
the ``icon``, and the ``type``. This examle adds an icon for sending an email:
the ``icon``, and the ``type``. This example adds an icon for sending an email:

.. code-block:: python

Expand Down