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.

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

Fixing docs build on MacOS, and fixing docs docs #1719

Merged
merged 1 commit into from
Jun 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,9 @@ venv*/
*.h5
*.txt

# metadata file specific to MacOS
.DS_Store

# vis files
*.vtu
*.vtd
Expand Down
2 changes: 1 addition & 1 deletion doc/developer/documenting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Building the documentation
Before building documentation, ensure that you have installed the test requirements into
your ARMI virtual environment with::

pip install -e .[test]
pip install -e .[docs]

You also need to have the following utilities available in your PATH:

Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,7 @@ docs = [
"sphinxcontrib-jquery==4.1", # Handle missing jquery errors
"jupyter-contrib-nbextensions", # A collections of JS extensions for jupyter notebooks
"lxml<5.0.0", # Needed because the dep above is no longer an active project
"wxPython", # optional for default install, needed for docs build
]

[project.scripts]
Expand Down
Loading