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

Documentation maintenance #4337

Merged
merged 8 commits into from
Aug 25, 2021
Merged

Documentation maintenance #4337

merged 8 commits into from
Aug 25, 2021

Conversation

jngrad
Copy link
Member

@jngrad jngrad commented Aug 25, 2021

Description of changes:

  • bump Sphinx version requirements to 2.3.0 (several older versions fail to build the documentation)
  • fix inconsistent Sphinx indentation that was misinterpreted as quotation blocks in the HTML output
  • make quotation blocks clearly visible with a different background color and stylized quote symbols
  • spellcheck and grammar check, document P3M verbose argument, update Correlator docstring

@jngrad
doc: spellcheck and grammar check
dcf1749
@jngrad
doc: Rephrase
4f3e8cc
@jngrad
python: Document P3M option
e3dbddd
@jngrad
python: Bump Sphinx version requirements
a679d0b
@jngrad
doc: Fix reSt formatting issues
e623943 
When the number of leading whitespaces is incorrect, an indented
paragraph or indented list item will be interpreted as a quote
and be rendered inside a HTML <blockquote> tag. Since blockquotes
have no CSS style, they are simply offset to the right, breaking
the flow of the document.
@jngrad
doc: Make blockquotes visible
a56caa5
@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB

@jngrad @reinaual
doc: Apply suggestions from code review
81ae1b2 
Co-authored-by: Alexander Reinauer <38552369+reinaual@users.noreply.github.com>
@jngrad jngrad marked this pull request as ready for review August 25, 2021 08:33
@jngrad jngrad added this to the Espresso 4.2 milestone Aug 25, 2021
@jngrad jngrad added the automerge Merge with kodiak label Aug 25, 2021
@kodiakhq kodiakhq bot merged commit d5360a1 into espressomd:python Aug 25, 2021
@jngrad jngrad deleted the bump_sphinx_230 branch August 31, 2021 14:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@reinaual reinaual reinaual approved these changes

Assignees
No one assigned
Labels
automerge Merge with kodiak Documentation
Projects
None yet
Milestone
Espresso 4.2.0
Development

Successfully merging this pull request may close these issues.
2 participants
@jngrad @reinaual