-
Notifications
You must be signed in to change notification settings - Fork 12
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.
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
Split software/index.rst into multiple directories and files #61
Comments
Merged
ptheywood
added a commit
that referenced
this issue
Jan 31, 2022
…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 History was a little messy, so has been squashed to avoid `.git` bloat.
ptheywood
added a commit
that referenced
this issue
Jan 31, 2022
…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.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
The main software/index.rst is already large and growing.
It may be worth splitting this into many smaller files for maintainability.
In some cases this willl seem excessive (currently) wheer pages are short on detail, but in others such as the python area this may make more sense.
It would also provide an opportunity for further organisaion. i.e. separating libraries such as
boost
orNCCL
from languages / runtimes such asR
orpython
, or from compiler (modules), or specific applications (suites) such as gromacs.It may be worth attempting to mirror the module system to a certain degree for navigability.
This would also allow the profiling top level to be folded into software.
I.e. as a very quick/rough mock up of a subset of the files that might need to be created :
This will be a major conflict with any active PR's, so ideally will want doing in isolation.
The text was updated successfully, but these errors were encountered: