Build documentation #66
Conversation
binder/environment.yml
Outdated
| - -r file:../requirements.txt | ||
| - nbsphinx-link | ||
| - recommonmark | ||
| - sphinx-git | ||
|
|
There was a problem hiding this comment.
why those packages are installed through pip?
There was a problem hiding this comment.
I don't know. It was a legacy from the initial version of the repo. It contains buildH own dependencies:
numpy
pandas
MDAnalysis
To you want me to merge this into binder/environment.yml?
There was a problem hiding this comment.
No I meant those 3:
- nbsphinx-link
- recommonmark
- sphinx-git
There was a problem hiding this comment.
Because they were not available in conda some times ago. But now, only sphinx-git is not available in conda. I'll fix this. Thanks!
There was a problem hiding this comment.
By the way, I will remove sphinx-git. This extension includes in the documentation the last commits. It is not very useful in our cases given we have CHANGELOG.md that can be imported in documentation.
docs/buildh.md
Outdated
| - `order_parameter_definitions_MODEL_Berger_POPC.def` (option `-d`, present in this repo). | ||
|
|
||
| The program needs one mandatory file (present in this repo): | ||
| - `order_parameter_definitions_MODEL_Berger_POPC.def` (option `-d`). | ||
|
|
||
|
|
||
| #### dic_lipids.py |
There was a problem hiding this comment.
Should I remove these 2 lines?
The program needs one mandatory file (present in this repo):
- `order_parameter_definitions_MODEL_Berger_POPC.def` (option `-d`).
There was a problem hiding this comment.
The interest peak is confusing. I meant : "#### dic_lipids.py"
There was a problem hiding this comment.
OK. I'll remove the corresponding paragraph.
|
The content of the documentation itself may be a bit rough. We should work on it and add more consistency later. |
|
Thanks @HubLot |
There was a problem hiding this comment.
Nice work, thanks @pierrepo. We only have to remember to replace the removed comment on dic_lipipds.py by something about the json files. To me it's fine for the merge 😄 !
|
I created an issue about it |
|
OK thanks @HubLot & @patrickfuchs ! |
This PR aims at building documentation with Sphinx.
This is a prerequisite to automatically build documentation at ReadTheDocs.
This should fix #35
To try this PR, you need to update your conda dev environement:
Then activate the
buildhconda env:Eventually, you can build the documentation:
And open docs at
docs/_build/html/index.html