You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+1-6Lines changed: 1 addition & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -56,19 +56,14 @@ Unit and Integration tests can be found in the `tests/` directory. You can run t
56
56
57
57
You can view the code coverage report by running `coverage html` and `python3 -m http.server --directory htmlcov` after running the unit tests.
58
58
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
-
63
59
### Creating a Release
64
60
65
61
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/).
66
62
67
63
The steps to do this are:
68
64
69
65
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`
72
67
3. Commit changes and push to the main branch.
73
68
4. Create a new release in the GitHub UI.
74
69
5. Observe the release action succeed and see the latest version of this library on PyPI.
0 commit comments