Skip to content

Commit

Permalink
docs: update README with documentation site info
Browse files Browse the repository at this point in the history
  • Loading branch information
niquerio committed Oct 16, 2024
1 parent 9ea2930 commit 48d5f9d
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,18 @@ The other is `client`, which provides a `fastapi` `TestClient` that knows about
### CLI tests
The `typer` `CliRunner` works without special modification. This is a good place to put in some integration tests since this is the entrypoint for using the application. That said, it's ok to mock out things like database calls.

## Documentation

Documentation lives in the `/docs` directory.

[Sphinx](https://www.sphinx-doc.org) is used to generate the documentation website.

The [documentation site](https://mlibrary.github.io/aim-py/) is built with a Github Action on each push to main.

We are using [Google style docstrings](https://google.github.io/styleguide/pyguide.html#s3.8-comments-and-docstrings).

In development the documentation should build automatically and be available at http://localhost:8888/

## Deployment

### Production Docker image
Expand Down

0 comments on commit 48d5f9d

Please sign in to comment.