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: CONTRIBUTING.md
+8-5Lines changed: 8 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -75,7 +75,7 @@ If there are autodoc issues/errors in remote builds of the docs, we need to add
75
75
### Test release to `test.pypi.org` (manual)
76
76
77
77
1. Bump the release version in `causalpy/version.py`. This is automatically read by `setup.py` and `docs/config.py`.
78
-
2.Update on test.pypi.org. _Note that this requires username and password for test.pypi.org_. In the root directory type the following:
78
+
2.Build locally and upload to test.pypi.org. _Note that this requires username and password for test.pypi.org_. In the root directory type the following:
1. If not done in the previous step, bump the release version in `causalpy/version.py`. This is automatically read by `setup.py` and `docs/config.py`.
97
-
2. Update on pypi.org. In the root directory:
98
-
-`python setup.py sdist`
99
-
- update to pypi.org with `twine upload dist/*` Note that this requires username and password for pypi.org.
96
+
1. Bump the release version (if not done in the previous step) in `causalpy/version.py`. This is automatically read by `setup.py` and `docs/config.py`.
97
+
2. Build locally and upload to pypi.org. In the root directory:
98
+
```bash
99
+
rm -rf dist
100
+
python setup.py sdist
101
+
twine upload dist/*
102
+
```
100
103
3. Readthedocs:
101
104
- Docs should be built remotely every time there is a pull request
102
105
- See here https://docs.readthedocs.io/en/stable/tutorial/#versioning-documentation for versioning the docs
0 commit comments