CFD/hypre
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs/misc.rst: fix rst syntax for italics (#690)

Browse Source 
* docs/README: add tip for viewing local docs using Python webserver.
* docs/misc.rst: fix rst syntax for italics.
This commit is contained in:
Fredrik Ekre 2022-07-30 02:10:00 +02:00 committed by GitHub
parent 662e886881
commit fac5ba173f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/docs/README.md
View File

@ -76,6 +76,12 @@ 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/usr-manual-html/index.html
file:///home/falgout2/hypre/src/docs/ref-manual-html/index.html file:///home/falgout2/hypre/src/docs/ref-manual-html/index.html
Alternatively, run a (local) webserver:
python3 -m http.server --directory usr-manual-html
and open http://localhost:8000 in a browser.
## Some useful links ## Some useful links
Sphinx: Sphinx:

2
src/docs/usr-manual/ch-misc.rst
View File

@ -287,7 +287,7 @@ Error Flags
Every hypre function returns an integer, which is used to indicate errors Every hypre function returns an integer, which is used to indicate errors
during execution. Note that the error flag returned by a given function during execution. Note that the error flag returned by a given function
reflects the errors from {\em all} previous calls to hypre functions. In reflects the errors from *all* previous calls to hypre functions. In
particular, a value of zero means that all hypre functions up to (and particular, a value of zero means that all hypre functions up to (and
including) the current one have completed successfully. This new error flag including) the current one have completed successfully. This new error flag
system is being implemented throughout the library, but currently there are system is being implemented throughout the library, but currently there are