Build AMET2 Documentation
Registered by
Neil Davis
Description of how to build the AMET2 documentation using Sphinx
Blueprint information
- Status:
- Not started
- Approver:
- None
- Priority:
- Undefined
- Drafter:
- None
- Direction:
- Needs approval
- Assignee:
- None
- Definition:
- New
- Series goal:
- None
- Implementation:
-
Unknown
- Milestone target:
- None
- Started by
- Completed by
Related branches
Related bugs
Sprints
Whiteboard
Need to install Sphinx http://
cd into docs directory
run command:
* sphinx-build -b html . html_out
This tells sphinx to build an html version of the documentation from the .rst files in the current directory with the output going into a directory html_out
Then run commands:
* sphinx-build -b latex . latex
* cd latex
* make
This will build a PDF version of the documentation in the latex directory called AMET.pdf
(?)
