Online manual formatting broken
Text enclosed within <!--QuietIdx--> <!--EQuietIdx--> blocks messes up the online manual, specifically noted in mdp_opt.html. These blocks lead to text duplication throughout the page. The delimiters can be easily deleted, but I don't know what their purpose is.
Add mdp-options to user guide
Formating changes to create hyperlink targets and index entries using
custom reStructuredText directives. There are likely many
opportunities for cross-references that are not yet implemented.
With some extra effort (not using the convenient add_object_type()), it
should also be possible to remove the integrator= part from references
to mdp values and add customized index entries for them, but with the
current directive and role syntax, that can be done independently from
writing the documentation.
#1 Updated by Mark Abraham over 7 years ago
- Status changed from New to Accepted
- Target version changed from 4.6.2 to 4.6.3
- Affected version set to 4.6
In the cavernous depths of time, there was only Idx, which was used to make LaTeX manual index entries, and silently passed those through to the HTML version. But sometimes the text doesn't match what the index entry should be, so I added QuietIdx. This is correctly processed for LaTeX, and I never thought about what the HTML would do with it. Answer: the unknown tag is ignored.
#4 Updated by Mark Abraham over 6 years ago
- Status changed from In Progress to Accepted
- Priority changed from Normal to Low
- Target version changed from 4.6.x to future
My release script has a hack that works around this. We can fix it properly some time when we have a chance to overhaul the documentation.
#5 Updated by Rossen Apostolov about 6 years ago
- Project changed from GROMACS to Documentation
- Category deleted (
Moving the issue to "Documentation" sub-project.
Shall we remove the "documentation" category in "Gromacs" or alternatively, remove the "Documentation" sub-project? It seems redundant with both.
#7 Updated by Rossen Apostolov about 6 years ago
- Project changed from Documentation to GROMACS
- Category set to documentation
the good thing about having it as a separate project is that it's easier to see if somebody wants to contribute specifically to the documentation. But there hasn't been a stampede of contributors :) I'll move then the issues as categories and remove the sub-project