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.

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

New manual version #1207

Open
wants to merge 12 commits into
base: master
Choose a base branch
from
Open

New manual version #1207

wants to merge 12 commits into from

Conversation

gtribello
Copy link
Member

Description

This is the first step towards fixing the PLUMED manual. I have completely rewritten the build system for the manual and have also reorganised the documentation. I think this will make the manual easier to maintain. I also think this new manual fits better with the documentation efforts that we have done with plumed tutorials and plumed nest.

I have made a video that gives you a brief tour of the new manual here.

Ideally, I would like to get this merged in the next couple of weeks. There are two things that need to be fixed before we can merge this. These are:

  1. We need to stop cppcheck throwing an error if it doesn't find a \par Examples statement in the documentation, as that is not needed anymore.
  2. I would also stop cppcheck throwing an error if actions are registered and there is no PLUMEDOC section. The problem is that there are now some actions (e.g. CUSTOM_VECTOR) that are only ever created from shortcuts. These actions do not need documentation sections. Furthermore, the report page for the new manual shows you where the problems are.

In the longer term, we need to convert all the current documentation from Doxygen to GitHub markdown. I have done a lot of this already for a lot of the code that I wrote. I actually rewrote the documentation for these actions because, although the syntax is mostly the same, the way I would recommend using the code changed significantly since we made the updates for plumed 2.10. My next step would thus be to merge all the new documentation I have written so far and put that in a second PR to merge after this one. I would then rework the rest of the code documentation once those new documentation items are merged.

The thing I want to avoid is having to keep this branch of the code up to date with master for a long time. If the decision is made to change the manual I think we can do a few short development spints with PRs at the end of them to get everything updated before the new manual is released in 2.11.

Target release

I would like my code to appear in release 2.11

Type of contribution
  • changes to code or doc authored by PLUMED developers, or additions of code in the core or within the default modules
  • changes to a module not authored by you
  • new module contribution or edit of a module authored by you
Copyright
  • I agree to transfer the copyright of the code I have written to the PLUMED developers or to the author of the code I am modifying.
  • the module I added or modified contains a COPYRIGHT file with the correct license information. Code should be released under an open source license. I also used the command cd src && ./header.sh mymodulename in order to make sure the headers of the module are correct.
Tests
  • I added a new regtest or modified an existing regtest to validate my changes.
  • I verified that all regtests are passed successfully on GitHub Actions.

@gtribello gtribello added the wip Do not merge label Feb 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
wip Do not merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants