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

Expand documentation build troubleshooting guide to discuss missing toctrees #2257

Merged
merged 12 commits into from
Oct 4, 2023

Conversation

namurphy
Copy link
Member

@namurphy namurphy commented Jul 27, 2023

This PR expands the troubleshooting section of the documentation guide to include a description of what to do when we encounter documentation build warnings related to missing toctrees.

This warning arose in #2191.

@github-actions
Copy link

Thank you for submitting a pull request (PR) to PlasmaPy! ✨ The future of the project depends on contributors like you, so we deeply appreciate it! 🌱

Our contributor guide has information on:

The bottom of this page shows several checks that are run for every PR. Don't worry if something broke! We break stuff all the time. 😺 Click on "Details" to learn why a check didn't pass. Please also feel free to ask for help. We do that all the time as well. 🌸 You can find us in our chat room or weekly community meeting & office hours. Here are some tips:

  • Try fixing CI / Python 3.11 test failures first.
  • Most pre-commit.ci - pr failures can be automagically fixed by commenting pre-commit.ci autofix below, followed by a git pull to bring the changes back to your computer.
  • If pre-commit.ci - pr says that a function is too long or complex, try breaking up that function into multiple short functions that each do one thing. See also these tips on writing clean scientific software.
  • If the CI / Documentation check ends with a cryptic error message, check out our documentation troubleshooting guide.
  • For a documentation preview, click on Details next to docs/readthedocs.org:plasmapy.

If this PR is marked as ready for review, someone should stop by to provide a code review and offer suggestions soon. ✅ If you don't get a review within a few days, please feel free to send us a reminder.

Please also use SI units within PlasmaPy, except when there is strong justification otherwise or in some examples.

We thank you once again!

@github-actions github-actions bot added docs PlasmaPy Docs at http:https://docs.plasmapy.org contributor guide labels Jul 27, 2023
@codecov
Copy link

codecov bot commented Jul 27, 2023

Codecov Report

All modified lines are covered by tests ✅

Comparison is base (99f905b) 98.35% compared to head (c9cd132) 98.35%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2257   +/-   ##
=======================================
  Coverage   98.35%   98.35%           
=======================================
  Files         101      101           
  Lines        8580     8580           
=======================================
  Hits         8439     8439           
  Misses        141      141           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@namurphy namurphy marked this pull request as ready for review August 17, 2023 17:18
@namurphy namurphy requested a review from a team as a code owner August 17, 2023 17:18
@namurphy namurphy requested review from JaydenR2305 and removed request for a team August 17, 2023 17:18
@namurphy namurphy added the status: ready for review PRs that are ready for code review label Aug 17, 2023
@namurphy namurphy changed the title Begin section of docs troubleshooting guide on missing toctrees Expand documentation build troubleshooting guide to discuss missing toctrees Sep 2, 2023
@namurphy namurphy requested review from ejohnson-96 and removed request for JaydenR2305 October 4, 2023 00:21
Copy link
Contributor

@ejohnson-96 ejohnson-96 left a comment

Choose a reason for hiding this comment

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

👍

@namurphy namurphy merged commit 86efbe0 into PlasmaPy:main Oct 4, 2023
14 checks passed
@namurphy namurphy deleted the doc-guide-missing-toctree branch October 4, 2023 18:06
@github-actions github-actions bot removed the status: ready for review PRs that are ready for code review label Oct 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contributor guide docs PlasmaPy Docs at http:https://docs.plasmapy.org
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants