From 1c2fdc53ffefeafa5f0f259b8981e85f55ac36bc Mon Sep 17 00:00:00 2001 From: Maxime Rey <87315832+MaxJPRey@users.noreply.github.com> Date: Tue, 9 Aug 2022 22:06:03 +0200 Subject: [PATCH] Fix general details. (#91) --- doc/source/404_page.rst | 4 ++-- doc/source/index.rst | 2 -- doc/source/options.rst | 6 +++--- 3 files changed, 5 insertions(+), 7 deletions(-) diff --git a/doc/source/404_page.rst b/doc/source/404_page.rst index 136a2ba40..ec00e3daa 100644 --- a/doc/source/404_page.rst +++ b/doc/source/404_page.rst @@ -4,7 +4,7 @@ Because Sphinx does not create a 404 page by default, you can use the `sphinx-notfound-page `_ extension -for 404 pages. While originally developed for use by on `Read the Docs `_, +for 404 pages. While originally developed to be used with `Read the Docs `_, this extension can be used in other hosting services. For more information, see the extension's `documentation `_. @@ -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 diff --git a/doc/source/index.rst b/doc/source/index.rst index 59dbd4087..b6b360330 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -2,8 +2,6 @@ Ansys Sphinx theme documentation |version| ========================================== -.. - Simply reuse the root readme .. include:: ../../README.rst diff --git a/doc/source/options.rst b/doc/source/options.rst index cf2dda1fc..8ea196946 100644 --- a/doc/source/options.rst +++ b/doc/source/options.rst @@ -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: @@ -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 @@ -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