Skip to content

Commit

Permalink
Merge pull request #65 from krishnasism/docs/add-missing-readme-part-…
Browse files Browse the repository at this point in the history
…20012024-krish

Update readme with documentation guide
  • Loading branch information
krishnasism authored Jan 19, 2024
2 parents cfc92cb + 4214e24 commit 0b15117
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,22 @@ python3 -m pip install -e '.[dev]' # install extra deps for testin
python3 -m pytest -n=auto test/ # run the test suite
```

### Documentation

We use [sphinx](https://www.sphinx-doc.org/en/master/) for generating our docs and host them on [readthedocs](https://readthedocs.org/)

Please update and add documentation if required, with your contributions.

Update the `.rst` files, rebuild them, and commit them along with your PRs.

```bash
cd docs
make clean
make html
```

This will generate the necessary documentation files. Once merged to `main` the docs will be updated automatically.

## Usage

**To view more detailed usage information, please [read the docs](https://hotpdf.readthedocs.io/en/latest/)**
Expand Down

0 comments on commit 0b15117

Please sign in to comment.