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.

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

Clarify use-case and docs structure #648

Merged
merged 2 commits into from May 3, 2022
Merged

Conversation

choldgraf
Copy link
Collaborator

This is a quick PR to clarify how documentation structure maps onto the structure of this theme, and to provide guidance for folks that want a single-sidebar theme instead. cc @zaneselvans who I think was confused by our docs - would this help?

@zaneselvans
Copy link

Hey thanks! Yes, this would have made it much clearer. My first intuition was that I had messed up the formatting or configuration somehow, or done something dumb that just wasn't being exercised on the RTD theme. Knowing that this is the expected behavior and that users might want to re-jigger the toctree into a small number of high-level sections with a number of sub-pages is definitely helpful.

Copy link
Collaborator

@damianavila damianavila left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@choldgraf choldgraf merged commit 9d568d7 into pydata:master May 3, 2022
@choldgraf choldgraf deleted the docs-clarify branch May 3, 2022 08:37
@jarrodmillman jarrodmillman added this to the 0.9 milestone Jun 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants