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.

Sign up for GitHub

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

improve documentation building guide #812

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

improve documentation building guide #812

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
83c85e7
add doxygen and configure to doc building guide
MFTabriz Jan 10, 2023
e634521
add link to doxygen download
MFTabriz Jan 10, 2023
8a44869
cleanup
MFTabriz Jan 10, 2023
7e5d87a
Merge branch 'master' into master
MFTabriz Jan 12, 2023
6294edd
fix conflict resolve
MFTabriz Jan 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 11 additions & 4 deletions src/docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,24 +59,31 @@ to your home directory (here, it's set to `~/texlive/2019`) and install:
Add `~/texlive/2019/bin/x86_64-linux` to your `PATH` and do `which pdflatex` to
verify that you did it correctly.

You also need doxygen to build the documentation. You can use a statically
linked binary release or alternatively you can compile it from the source.
Please visit the [doxygen website](https://www.doxygen.nl/download.html)
for detailed instructions.

## Building the documentation

To build the documentation, first activate the virtual environment:

source ~/python-hypre/env/bin/activate

Now, just type `make` in the `src/docs` directory to build the documentation.

Run `./configure` in the `src/` directory and then go to the `src/docs` directory
and just type `make` to build the documentation in pdf and html formats.

When you are finished editing and building, turn off the virtual environment:

deactivate

To view the output, open a browser and navigate to the following links to see
To view the html output files, open a browser and navigate to the following links to see
the user and reference manuals (adjust the path as needed):

file:///home/falgout2/hypre/src/docs/usr-manual-html/index.html
file:///home/falgout2/hypre/src/docs/ref-manual-html/index.html

Alternatively, run a (local) webserver:
Alternatively, you can run a (local) webserver:

python3 -m http.server --directory usr-manual-html

Expand Down