From abd951a9cd98851269b8b5f5e59b1b4d29b1416c Mon Sep 17 00:00:00 2001 From: Jesse Tan Date: Wed, 24 Jan 2018 15:44:42 +0100 Subject: [PATCH] Readme cleanup (#554) * Move badges below title * typekit_id is a string * Fix some text uninententionally bold * More accurately describe install * Proper italics instead of non-working underline * MD style inline code to rst style * hidden is a :property: --- README.rst | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/README.rst b/README.rst index c00f7479..4046f893 100644 --- a/README.rst +++ b/README.rst @@ -8,6 +8,10 @@ .. _demo: https://sphinx-rtd-theme.readthedocs.io/en/latest/ .. _hidden: http://sphinx-doc.org/markup/toctree.html +************************** +Read the Docs Sphinx Theme +************************** + .. image:: https://img.shields.io/pypi/v/sphinx_rtd_theme.svg :target: https://pypi.python.org/pypi/sphinx_rtd_theme .. image:: https://travis-ci.org/rtfd/sphinx_rtd_theme.svg?branch=master @@ -19,11 +23,7 @@ :target: http://sphinx-rtd-theme.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status -************************** -Read the Docs Sphinx Theme -************************** - -.. contents:: +.. contents:: :backlinks: none View a working demo_ over on readthedocs.org_. @@ -40,7 +40,7 @@ Installation Via package ----------- -Download the package or add it to your ``requirements.txt`` file: +Install the package (or add it to your ``requirements.txt`` file): .. code:: bash @@ -107,14 +107,14 @@ The following options are available: Base options ~~~~~~~~~~~~ -* ``typekit_id`` This will let users specify a typekit id to use for displaying nicer fonts. +* ``typekit_id`` String. This will let users specify a typekit id to use for displaying nicer fonts. * ``canonical_url`` String. This will specify a `canonical url `__ to let search engines know they should give higher ranking to latest version of the docs. The url points to the root of the documentation and requires a trailing slash. * ``analytics_id`` String. Change the Google Analytics ID that is included on pages. * ``display_version`` Bool. With this disabled, the version number isn't shown at the top of the sidebar. * ``prev_next_buttons_location`` String. can take the value ``bottom``, ``top``, ``both`` , or ``None`` - and will display the "Next" and "Previous" buttons accordingly. + and will display the "Next" and "Previous" buttons accordingly. * ``style_external_links`` Bool. Add an icon next to external links. Defaults to ``False``. TOC Options @@ -122,11 +122,11 @@ TOC Options These effect how we display the Table of Contents in the side bar. You can read more about them here: http://www.sphinx-doc.org/en/stable/templating.html#toctree -* ``collapse_navigation`` Bool. With this enabled, you will lose the `[+]` drop downs next to each section in the sidebar. - This is useful for _very large_ documents. +* ``collapse_navigation`` Bool. With this enabled, you will lose the ``[+]`` drop downs next to each section in the sidebar. + This is useful for *very large* documents. * ``sticky_navigation`` Bool. This causes the sidebar to scroll with the main page content as you scroll the page. * ``navigation_depth`` Int. Indicate the max depth of the tree; by default, all levels are included. -* ``includehidden`` Bool. Specifies if the sidebar includes toctrees marked with the `:hidden:` option +* ``includehidden`` Bool. Specifies if the sidebar includes toctrees marked with the ``:hidden:`` option * ``titles_only`` Bool. If True, removes headers within a page from the sidebar. Page-level configuration @@ -239,7 +239,7 @@ your documents, the toctree will misbuild, and the resulting menu might not show depth when it renders. Also note that by default the table of contents is set with ``includehidden=True``. This allows you -to set a hidden toc in your index file with the hidden_ property that will allow you +to set a hidden toc in your index file with the `:hidden: `_ property that will allow you to build a toc without it rendering in your index. By default, the navigation will "stick" to the screen as you scroll. However if your toc @@ -263,7 +263,7 @@ Set up your environment #. Install sphinx_ into a virtual environment. .. code:: bash - + pip install sphinx sphinxcontrib-httpdomain #. Install sass.