Skip to content

Commit

Permalink
Fix general details. (#91)
Browse files Browse the repository at this point in the history
  • Loading branch information
MaxJPRey authored Aug 9, 2022
1 parent 810e759 commit 1c2fdc5
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 7 deletions.
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
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

0 comments on commit 1c2fdc5

Please sign in to comment.