Modernize user guide #4504
Merged
Modernize user guide #4504
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Update configuration for Doxygen 1.8.17 with `doxygen -u`. Remove default-valued fields that will be deprecated in Doxygen 1.9.1.
The shell script should be called directly instead of the python script.
Synchronize keys and fields with icp.bib. Use full journal names and add DOI fields.
The sphinxcontrib.bibtex package no longer requires the `zref` filename workaround since version 2.0.0 and no longer requires two builds since version 2.1.0. The bibliography is now always up-to-date.
Improve readability by using short links to class methods and attributes, instead of using the fully qualified namespace. E.g. "the property `espressomd.particle_data.ParticleHandle.rinertia`" becomes "the property `rinertia`" in paragraphs about particles.
Replace examples written in pseudo-code (e.g. those involving bracketed placeholder text of the form <particle_id>) by real code. Make code samples more self-contained with a proper System setup.
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
Declutter the table of contents on the main page. Rework chapter sections. Rename chapter on integrators and thermostats.
Collect content on how to run ESPResSo from various chapters and consolidate the information in a self-contained chapter.
Split the Contributing chapter to create a Community chapter. Document the Summer School and how to access the teaching material. Update the Contributing page of the project community standards.
pkreissl
suggested changes
Apr 20, 2022
To build the docs, first run |
Center main text in the alabaster theme. Fix typos and grammar. Co-authored-by: Patrick Kreissl <[email protected]>
christophlohrmann
approved these changes
Apr 26, 2022
reinaual
approved these changes
Apr 26, 2022
|
|
||
| Debugging |es| | ||
| -------------- | ||
| The resulting build with be quite slow but will enable many debugging tools. |
There was a problem hiding this comment.
good catch, I'll wrap this up when running the spellchecker during the release process next month
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of changes: