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

docs: fix intro notebook, and submodule and subpackage index #191

Merged
merged 2 commits into from
May 20, 2022

Conversation

Saransh-cpp
Copy link
Member

Issues

  • The intro notebook is currently broken because of missing extra \s when writing latex.
  • There are no differences between H2 and H3 headings which makes the index in the documentation behave weirdly.

Changes done

  1. All the submodule headings are now H3 and the headings saying "Submodule" are H2.
  2. Vector's direct submodules have their independent rst files and pages now (The documentation for the submodules currently renders directly in the index page).
  3. Added information about vector on the landing page.
  4. Fixed the intro notebook.

Screenshots

Sidebar index

Current

image

New

image

vector index

Current

image

New

image

vector package index

Current

image

New

image

Direct submodule documentation

Current

image

New

image

Contents bar

Current

image

New

image

@henryiii
Copy link
Member

I'd recommend running pre-commit run -a locally to see what it's complaining about. See https://scikit-hep.org/developer/style.

docs/index.rst Outdated Show resolved Hide resolved
Co-authored-by: Henry Schreiner <HenrySchreinerIII@gmail.com>
@Saransh-cpp
Copy link
Member Author

Thank you! Installed pre-commit locally!

@henryiii henryiii merged commit c826c63 into scikit-hep:main May 20, 2022
@henryiii
Copy link
Member

Thanks!

@Saransh-cpp Saransh-cpp deleted the fix-docs branch May 20, 2022 17:18
@Saransh-cpp Saransh-cpp added this to the v0.9.0 milestone Feb 17, 2023
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.

2 participants