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

added introduction #3848

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

Nancy9ice
Copy link
Contributor

Overview:
Closes this Google Season of Docs Task:
Add the readthedocs landing page as the Introduction in the Table of Contents

What problem does this address?
This adds the landing page to the table of contents to ease navigation

Testing
How did you make sure this worked? How can a reviewer verify this?
I tested it by running make make docs-build

@aesharpe @zaneselvans @e-belfer

@e-belfer e-belfer self-requested a review September 17, 2024 20:14
@e-belfer e-belfer added the docs Documentation for users and contributors. label Sep 17, 2024
Copy link
Member

@e-belfer e-belfer left a comment

Choose a reason for hiding this comment

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

Can we call this "About PUDL" instead of "Introduction"?

Rather than creating a blank index page and a new Introduction page, I think we need to add the index page to the TOC.

See: https://stackoverflow.com/questions/16123951/how-do-i-include-the-homepage-in-the-sphinx-toc

.. toctree::
:hidden:
:maxdepth: 2

Introduction <Introduction>
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Introduction <Introduction>
About PUDL <self>

This will create a reference to the page in the table of contents without needing to create a new page or having an empty index.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation for users and contributors.
Projects
Status: In progress
Development

Successfully merging this pull request may close these issues.

2 participants