Split software sources #67
Merged
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
ptheywood
force-pushed
the
split-software-sources
branch
from
6acedac to
7bbb27f
Compare
Closed
ptheywood
force-pushed
the
split-software-sources
branch
from
0381af2 to
d4498d5
Compare
ptheywood
force-pushed
the
split-software-sources
branch
from
d4498d5 to
541eda6
Compare
ptheywood
force-pushed
the
split-software-sources
branch
from
f188929 to
0841b81
Compare
This was referenced Jan 26, 2022
Closed
Closed
ptheywood
force-pushed
the
split-software-sources
branch
from
814ebe3 to
648c323
Compare
ptheywood
requested review from
jonathanfrawley,
jsteyn and
markdturner
and removed request for
jonathanfrawley
…ich are much more manageable, with their own easier to find rendered pages. Closes #61 Whilst splitting this file into many smaller files, a number of additions and changes were made to the documentation, including: + Adds (basic) documentation for: + IBM XL compilers (Closes #61) + Amber (Part of #78) + EMAN2 + GRACE + Gromacs (Closes #37, part of #79) + NAMD + OpenMM + PLUMED + Singularity (Apptainer) (Closes #49) + Generic python information, with more detailed conda usage (Closes #47) + nvidia-smi (Closes #75) + HECBioSim project + IBM Collaboration project + Boost Module + FFTW module + NVTX library + PLUMED library + VTK + CMake + Make + Creates new `guides` section + Migrates the `profiling` documentation into the guides section + Migrates the `wanderings` about CUDA into the guides section + Adds some notes/warnings about potential WMLCE + RHEL 8 incompatibility. Larger changes still required (#63) + CSS/JS/_templates changes for a useful sidebar with the bootstrap theme with split source files + New issue #87 opened to consider replacing the theme to an actively maintained theme. + Removes relations.html from the sidebar, as styling issues were difficult to resolve nicely (Closes #77) + Adds sphinxext-rediraffe plugin for redirects for moved .html files (see conf.py) + Assorted RST improvements (links, crossrefs, quoteblocks, code-block, note, etc.) + Clarify module loads for RHEL 7 vs RHEL 8 where appropriate (Part of #73). + Assorted other improvements throughout the documentation + Adds the sphinx-copybutton plugin, for easy to copy code-block contents. History was a little messy, so has been squashed to avoid `.git` bloat.
ptheywood
force-pushed
the
split-software-sources
branch
from
648c323 to
4417a1e
Compare
This was referenced Jan 31, 2022
markdturner
approved these changes
Feb 7, 2022
|
This build has failed on RTD, likely my changes to requirements.txt given the previous version of sphinx was several major versions behind. I'll figure out how to fix it and get a new PR in (although I'm not sure why it didn't fail locally with the same https://readthedocs.org/projects/bede-documentation/builds/16013603/ |
Closed
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.
This splits the software documentation into many smaller rst files which are much more manageable, with their own easier to find rendered pages.
Closes #61
Whilst splitting this file into many smaller files, a number of additions and changes were made to the documentation, including:
guidessectionprofilingdocumentation into the guides sectionwanderingsabout CUDA into the guides sectionHistory was a little messy, so has been squashed to avoid
.gitbloat.