-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathnotes_to_self.txt
19 lines (17 loc) · 1.01 KB
/
notes_to_self.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
About setting up the imports correctly:
https://github.com/pytest-dev/pytest/issues/2421#issuecomment-332158308
- make the package installable
- install it in virtualenv while developing with pip install --editable /home/wesley/flexpy
-- NOT pip install --editable flexpy (this will put it somewhere else in the virtualenv site-packages or something, so your edits won't change anything in its behavior)
- test the package with tox
https://comeroutewithme.com/2018/02/24/python-relative-imports-and-unittests-derp/
http://python-notes.curiousefficiency.org/en/latest/python_concepts/import_traps.html
About setting up ReadTheDocs/Sphinx:
https://docs.readthedocs.io/en/stable/intro/getting-started-with-sphinx.html
This post argues for RST and Sphinx as better than Markdown for writing docs in the long term: https://www.zverovich.net/2016/06/16/rst-vs-markdown.html
RST cheat sheet: https://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html
to generate Sphinx docs:
sphinx-apidoc -o docs/ flexpy/
cd docs
make clean
make html