Replace include of readme on index with actual content

If we want the Readme to have more links, this breaks linking at the
index page in the built documentation. The version is hardcoded in links
in the readme version, and hardcoded links point to the wrong version in
the documentaiton
This commit is contained in:
Anthony Johnson 2021-08-17 14:34:47 -06:00
parent bdd49c4eb3
commit b880004ce0
No known key found for this signature in database
GPG Key ID: 709FE91423F05AA0

View File

@ -1,8 +1,57 @@
.. include:: ../README.rst Read the Docs Sphinx Theme
==========================
This Sphinx_ theme was designed to provide a great reader experience for
documentation users on both desktop and mobile devices. This theme is commonly
used with projects on `Read the Docs`_ but can work with any Sphinx project.
.. _Sphinx: http://www.sphinx-doc.org
.. _Read the Docs: http://www.readthedocs.org
Using this theme
----------------
:doc:`installing`
How to install this theme on your Sphinx project.
:doc:`configuring`
Theme configuration and customization options.
:ref:`supported-browsers`
Supported browser/operating system combinations.
:ref:`supported-dependencies`
Supported project dependencies, like Python and Sphinx.
Development
-----------
:doc:`contributing`
How to contribute changes to the theme.
:doc:`Development guidelines <development>`
Guidelines the theme developers use for developing and testing changes.
`Read the Docs contributor guide`_
Our contribution guidelines extend to all projects maintained by Read the
Docs core team.
:doc:`changelog`
The theme development changelog.
:doc:`Demo documentation <demo/structure>`
The theme's styleguide test environment, where new changes are tested.
.. _Read the Docs contributor guide: https://docs.readthedocs.io/en/stable/contribute.html
.. Hidden TOCs
.. toctree:: .. toctree::
:caption: Theme Documentation :caption: Theme Documentation
:maxdepth: 2 :maxdepth: 2
:hidden:
installing installing
configuring configuring
@ -19,6 +68,7 @@
:maxdepth: 2 :maxdepth: 2
:numbered: :numbered:
:caption: Demo Documentation :caption: Demo Documentation
:hidden:
demo/structure demo/structure
demo/demo demo/demo
@ -29,5 +79,6 @@
:maxdepth: 3 :maxdepth: 3
:numbered: :numbered:
:caption: This is an incredibly long caption for a long menu :caption: This is an incredibly long caption for a long menu
:hidden:
demo/long demo/long