Skip to content
Snippets Groups Projects
Commit 8edd0dba authored by Gareth Tribello's avatar Gareth Tribello Committed by Giovanni Bussi
Browse files

Added explanation of [makedoc] into the developer manual

When you type [makedoc] the developer manual is updated online
parent 7c1b2e41
No related branches found
No related tags found
No related merge requests found
......@@ -3,6 +3,10 @@
\page usingDoxygen Creating plumed documentation
<B> Whenever you make a change to the documentation for PLUMED you need to write include the phrase
[makedoc] in your next commit message. Doing so ensures that the online manuals are updated the next
time you push your commits to master. </B>
To create the plumed manual you should go to the <b> user-doc </b> directory and type <b> make </b>.
This command works because user documentation for all the PLMD::Action is inside the source code. If
you look at the documentation page for any of the actions that are implemented in plumed you will
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment