Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
D
docs
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
exa
docs
Commits
bdb1d846
Commit
bdb1d846
authored
1 year ago
by
Justin Weber
Browse files
Options
Downloads
Patches
Plain Diff
Update README.md
parent
78522b88
No related branches found
Branches containing commit
No related tags found
No related merge requests found
Pipeline
#37217
passed
1 year ago
Stage: build-docs
Stage: deploy
Changes
1
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+22
-20
22 additions, 20 deletions
README.md
with
22 additions
and
20 deletions
README.md
+
22
−
20
View file @
bdb1d846
# 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:
...
...
@@ -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.
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment