-
Notifications
You must be signed in to change notification settings - Fork 297
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
gtribello
wants to merge
12
commits into
master
Choose a base branch
from
big-documentation-fix
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
New manual version #1207
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
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
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:
\par Examples
statement in the documentation, as that is not needed anymore.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
Copyright
COPYRIGHT
file with the correct license information. Code should be released under an open source license. I also used the commandcd src && ./header.sh mymodulename
in order to make sure the headers of the module are correct.Tests