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

Update Docs #4252

Merged
merged 1 commit into from
Dec 2, 2024
Merged

Update Docs #4252

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 1 addition & 3 deletions Docs/Readme.sphinx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
(***) We no longer edit the latex at all -- we edit the .rst files in amrex/Docs/sphinx_documentation/source in the *development* branch

To update the online AMReX documentation using sphinx:

1. Checkout the development branch of AMReX
Expand All @@ -8,7 +6,7 @@ To update the online AMReX documentation using sphinx:

3. Commit your changes.

The TravisCI script will build the html pages and commit them to AMReX's gh-pages branch for you. If you would like to
The GitHub action script will build the html pages and commit them to AMReX's gh-pages repo for you. If you would like to
preview the html locally, you can:

4. Go back into amrex/Docs/sphinx_documentation.
Expand Down