Skip to content

Commit 613e506

Browse files
author
Dan Hertz
committed
Update readme
1 parent 4a279b1 commit 613e506

File tree

1 file changed

+1
-6
lines changed

1 file changed

+1
-6
lines changed

README.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -56,19 +56,14 @@ Unit and Integration tests can be found in the `tests/` directory. You can run t
5656

5757
You can view the code coverage report by running `coverage html` and `python3 -m http.server --directory htmlcov` after running the unit tests.
5858

59-
### SDK Documentation
60-
61-
The SDK is documented using the Sphinx library. You can generatre the developer documentation using `make docs` and preview it on `localhost:8000` by running `make serve-docs`.
62-
6359
### Creating a Release
6460

6561
Releases are automatically published to PyPI using GitHub Actions. Creating a release in GitHub will trigger a new build that will publish the latest version of this library to [PyPI](https://pypi.org/project/nightfall/).
6662

6763
The steps to do this are:
6864

6965
1. Add what changed to the CHANGELOG file
70-
1. Update the version in `setup.py`
71-
1. Generate documentation with `make docs` to make sure it's up to date
66+
2. Update the version in `setup.py`
7267
3. Commit changes and push to the main branch.
7368
4. Create a new release in the GitHub UI.
7469
5. Observe the release action succeed and see the latest version of this library on PyPI.

0 commit comments

Comments
 (0)