forked from chasmani/piecewise-regression
-
Notifications
You must be signed in to change notification settings - Fork 0
/
setup_notes.txt
22 lines (19 loc) · 973 Bytes
/
setup_notes.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
To send a new version to the package manager:
1. Make sure everything works
2. Update the version number in setup.py and README.rst
3. 'python setup.py sdist bdist_wheel' - this creates a dist package in the dist/ folder
4. 'twine upload --skip-existing dist/*'
To make new docs:
1. navigate to the docs folder in terminal
2. type make html
3. Maybe also need to do 'python setup.py sdist bdist_wheel'
4. you might need to update the theme. Can be set in conf.py. Might also need to install 'sudo pip3 install sphinx-rtd-theme'
5. Push it all to github
6. On readthedocs.org - add github repo
7. It might take a few hours to propogate to read the docs.
8. You might need to add a requirements.txt, and maybe add it in the Advances Settings on readthedocs.org
Images:
If including an image in readme.rst. It needs to display in 3 places:
- Github. Can use relative or absolute link to github hosted image
- PyPI. Needs absolute link to github hosted image
- ReadTheDocs.