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

rst fixes #50

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

rst fixes #50

wants to merge 5 commits into from

Conversation

kzuberi
Copy link
Contributor

@kzuberi kzuberi commented Jan 27, 2023

multiple small fixes:

  • adding code-block type bash, fixes multiple missing blocks in the output e.g. in advanced_topics
  • one block needs to be console, since it contains single quote which breaks bash code-block handling
  • fixes unknown interpreted text role "raw-html-m2r", which was showing up in the output of e.g. best_practices
  • cleans up warnings to do with underlines being to short and some toctree directives in index, these just clutter the build output and obscure other real problems

@kzuberi
add type to code blocks
e03be6b
@kzuberi
raw block needs blank line
f548a34
@kzuberi
trivial: fix underline too short warnings
546ba06 
these warnings clutter up the sphinx output
and make it hard to see real problems
@kzuberi
remove nested toctree directives
866a279 
sphinx just thinks these are references to
non-existing documents. removing cleans up
warnings and the TOC still looks correct
@kzuberi
fix Unknown interpreted text role "raw-html-m2r"
eef780f
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@kzuberi