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.

Sign up for GitHub

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

Jump to bottom

Clarify use-case and docs structure #648

Merged
merged 2 commits into from
May 3, 2022
Merged

Clarify use-case and docs structure #648

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e6d95b0
Clarify use-case and docs structure
choldgraf Apr 29, 2022
f38b180
Clarify use-case and docs structure
choldgraf Apr 29, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
17 changes: 14 additions & 3 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,22 @@
The PyData Sphinx Theme
=======================

This is a simple, Bootstrap-based Sphinx theme from the PyData community. This
site is a guide for using the theme, and a demo for how it looks with various
A clean, Bootstrap-based Sphinx theme from the PyData community.
This theme is designed for more complex documentation that breaks into natural sub-sections.

It puts all top-level pages in your ``toctree`` into the header navigation bar.
The sidebar will be populated with second-level pages when a top-level page is active.
This allows you to group your documentation into sub-sections without cluttering the sidebar.

.. seealso::

If you are looking for a Sphinx theme that puts all of its sub-pages in the sidebar, the `Sphinx Book Theme <https://sphinx-book-theme.readthedocs.io/>`_ has a similar look and feel, and `Furo <https://pradyunsg.me/furo/quickstart/>`_ is another excellent choice.

This site is a guide for using the theme, and a demonstration for how it looks with various
elements.

Other sites that are using this theme:
Sites that use this theme
=========================

.. SORTED ALPHABETICALLY

Expand Down
10 changes: 10 additions & 0 deletions docs/user_guide/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,16 @@
User Guide
==========

The user guide describes how to use and customize this theme.

How the theme is structured
===========================

This theme converts all **top-level toctree items** into links in the header navigation bar.
The sidebar will have no navigation links until one of these top-level links is active (e.g., if you are on a sub-page of a top-level link).
Once one of the top-level links is active, the sidebar will be populated with a list of pages that are underneath the top-level page.

For example, see the links in the sidebar for the other pages in this section.

.. toctree::
:maxdepth: 2
Expand Down