Skip to content

Commit

Permalink
docs: Address review
Browse files Browse the repository at this point in the history
  • Loading branch information
adigitoleo committed Aug 5, 2024
1 parent 86f07cd commit 006aec9
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,13 +59,13 @@ They have their own README file as well.
The documentation can be built offline from a git clone or source distribution.
Install documentation builder dependencies with `pip install '.[doc]'`.

Run the make command `make html` which will output the documentation,
including the generated API reference, into a folder called `html`.
Run `make html` from the terminal to generate PyDRex's documentation
(available in the `html` directory), including the API reference.
The homepage will be `html/index.html`.

## Contributing

For a Linux development environment, clone the [source code](https://github.com/seismic-anisotropy/PyDRex)
For a Linux or MacOS development environment, clone the [source code](https://github.com/seismic-anisotropy/PyDRex)
and execute the Bash script `tools/venv_install.sh`.
This will set up a local Python virtual environment with an [editable install](https://setuptools.pypa.io/en/latest/userguide/development_mode.html)
of PyDRex that can be activated/deactivated by following the displayed prompts.
2 changes: 1 addition & 1 deletion tests/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# PyDRex tests

Running the base test suite requires [pytest](https://docs.pytest.org), and up to ~16GB RAM.
Running the base test suite requires [pytest](https://docs.pytest.org) and up to ~16GB RAM.
By default, `make test` will attempt to write persistent logs and output to `./out/`.

Alternatively, run `pytest` from the root of the source tree.
Expand Down

0 comments on commit 006aec9

Please sign in to comment.