We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
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
tl;dr add a Contributing Guide page / section containing the most common and/or arcade-specific sphinx concerns
This is a follow-up to a Discord conversation
What, where, when, and how to add things:
Guidelines for instructions
Which build formats are priority support targets
The most common problems and how to deal with them
Sphinx header underlines must have correct length to avoid sphinx warnings which break build
tl;dr of how to link things
:ref:`internal_link_name`
`text <ref_name_>`_
`text <ref_name>`_
:py:class:`Sequence`
:external:
Toctrees
#include
:hidden:
:includehidden:
Tips, such as HTML-only behavior
Links to more general sphinx doc
The text was updated successfully, but these errors were encountered:
An optional item I'm not yet sure on: using the :external: role with intersphinx.
Pros:
Cons:
objects.inv
Sorry, something went wrong.
Further style notes from recent PR reviews / etc:
instead of the
No branches or pull requests
Documentation request:
tl;dr add a Contributing Guide page / section containing the most common and/or arcade-specific sphinx concerns
This is a follow-up to a Discord conversation
What the overview should have
What, where, when, and how to add things:
Guidelines for instructions
Which build formats are priority support targets
The most common problems and how to deal with them
Sphinx header underlines must have correct length to avoid sphinx warnings which break build
tl;dr of how to link things
:ref:`internal_link_name`
`text <ref_name_>`_
`text <ref_name>`_
:py:class:`Sequence`
should just work:external:
for link targets to headingsToctrees
#include
analogy:hidden:
,:includehidden:
& furoTips, such as HTML-only behavior
Links to more general sphinx doc
What the page should avoid
The text was updated successfully, but these errors were encountered: