Loading README.md +22 −20 Original line number Diff line number Diff line # MFIX-Exa This is the public face of the MFIX-Exa project, hosting the documentation, gallery of results, etc. The website is: https://amrex-codes.github.io/MFIX-Exa/ # MFIX-Exa Documentation This is the documentation for MFIX-Exa. Every merge request to `main` will get built and synced to the AWS S3 bucket, through the pipeline, making the edits live. Side branches will only be built through the pipeline. The job artifact can be downloaded to see the built documentation. ## Editing ## User Manual The documentation source is in `docs/source/` and the html source for the cover page is in `docs/webroot/`. The MFIX-Exa User Manual is built using [sphinx](https://www.sphinx-doc.org/en/master/) with the source located in `docs/user-manual`. The `docs/user-manual/config.py` file contains the settings for building this documentation. :warning: **Do not push any edits to the `gh-pages` branch** as these will be overwritten. Instead, commit your changes to the `master` branch, and the `gh-pages` branch will be updated automatically a few minutes later. AWS S3: https://exa-doc.s3.amazonaws.com/user-manual/latest/index.html MFIX: https://mfix.netl.doe.gov/doc/mfix-exa/guide/latest ### Documentation ## MFIX-Exa PIC VVA Manual The MFIX-Exa User Manual is built using [sphinx](https://www.sphinx-doc.org/en/master/) with the source located in `docs/picvva`. The `docs/picvva/config.py` file contains the settings for building this documentation. AWS S3: https://exa-doc.s3.amazonaws.com/pic-vva/latest/index.html MFIX: https://mfix.netl.doe.gov/doc/mfix-exa/vva/pic/latest ## How to build docs locally The documentation is built using [sphinx](https://www.sphinx-doc.org/en/master/). The `docs/source/config.py` file contains the settings for building this documentation. The documentation [sphinx](https://www.sphinx-doc.org/en/master/). The documentation can be built locally by: 1. Install sphinx: Loading @@ -37,11 +47,3 @@ The HTML pages will now be located in the `build` directory. Open the ```shell > firefox build/index.html ``` ### Doxygen Whenever the online documentation is updated, a fresh doxygen will be generated also. Note that the configuration in `docs/doxygen/doxygen.conf` specifically prevent source code from being displayed. This is by design. If you want to create your own private doxygen containing the source code also, please configure and run the `doc/Doxyfile.in` in your clone of the MFiX-Exa repo. Loading
README.md +22 −20 Original line number Diff line number Diff line # MFIX-Exa This is the public face of the MFIX-Exa project, hosting the documentation, gallery of results, etc. The website is: https://amrex-codes.github.io/MFIX-Exa/ # MFIX-Exa Documentation This is the documentation for MFIX-Exa. Every merge request to `main` will get built and synced to the AWS S3 bucket, through the pipeline, making the edits live. Side branches will only be built through the pipeline. The job artifact can be downloaded to see the built documentation. ## Editing ## User Manual The documentation source is in `docs/source/` and the html source for the cover page is in `docs/webroot/`. The MFIX-Exa User Manual is built using [sphinx](https://www.sphinx-doc.org/en/master/) with the source located in `docs/user-manual`. The `docs/user-manual/config.py` file contains the settings for building this documentation. :warning: **Do not push any edits to the `gh-pages` branch** as these will be overwritten. Instead, commit your changes to the `master` branch, and the `gh-pages` branch will be updated automatically a few minutes later. AWS S3: https://exa-doc.s3.amazonaws.com/user-manual/latest/index.html MFIX: https://mfix.netl.doe.gov/doc/mfix-exa/guide/latest ### Documentation ## MFIX-Exa PIC VVA Manual The MFIX-Exa User Manual is built using [sphinx](https://www.sphinx-doc.org/en/master/) with the source located in `docs/picvva`. The `docs/picvva/config.py` file contains the settings for building this documentation. AWS S3: https://exa-doc.s3.amazonaws.com/pic-vva/latest/index.html MFIX: https://mfix.netl.doe.gov/doc/mfix-exa/vva/pic/latest ## How to build docs locally The documentation is built using [sphinx](https://www.sphinx-doc.org/en/master/). The `docs/source/config.py` file contains the settings for building this documentation. The documentation [sphinx](https://www.sphinx-doc.org/en/master/). The documentation can be built locally by: 1. Install sphinx: Loading @@ -37,11 +47,3 @@ The HTML pages will now be located in the `build` directory. Open the ```shell > firefox build/index.html ``` ### Doxygen Whenever the online documentation is updated, a fresh doxygen will be generated also. Note that the configuration in `docs/doxygen/doxygen.conf` specifically prevent source code from being displayed. This is by design. If you want to create your own private doxygen containing the source code also, please configure and run the `doc/Doxyfile.in` in your clone of the MFiX-Exa repo.
