Difference between revisions of "Talk:Vertx-eventbus-python"

From BITPlan Wiki
Jump to navigation Jump to search
 
(11 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
= Documentation =
 
= Documentation =
 +
== Sphinx ==
 
* https://packaging.python.org/tutorials/creating-documentation/
 
* https://packaging.python.org/tutorials/creating-documentation/
 +
* https://stackoverflow.com/a/46507300/1497139
 
<source lang='bash'>
 
<source lang='bash'>
 
sudo -H pip install -U sphinx
 
sudo -H pip install -U sphinx
 +
export PYTHONPATH=""
 +
python3 -m sphinx.cmd.quickstart
 +
sudo port -f install py37-sphinx
 +
sudo -H pip install sphinx_rtd_theme
 +
# Python3 bin
 +
export PATH="/opt/local/Library/Frameworks/Python.framework/Versions/3.7/bin:$PATH"
 
</source>
 
</source>
 +
* https://romanvm.pythonanywhere.com/post/autodocumenting-your-python-code-sphinx-part-ii-6/
 +
=== Issues ===
 +
* https://stackoverflow.com/questions/39738852/duplicate-index-warning-on-sphinx-build-how-do-i-include-a-file-without-indexin
 +
 +
= Readthedocs =
 
* https://readthedocs.org/dashboard/
 
* https://readthedocs.org/dashboard/
 +
* https://vertx-eventbus-python.readthedocs.io/en/latest/
 +
<source lang='bash'>
 +
pip install sphinx-rtd-theme
 +
</source>
 +
= PyPi =
 +
* https://packaging.python.org/tutorials/packaging-projects/
 +
<source lang='bash'>
 +
sudo -H  pip3 install --upgrade twine wheel
 +
</source>

Latest revision as of 22:18, 4 February 2020

Documentation

Sphinx

sudo -H pip install -U sphinx
export PYTHONPATH=""
python3 -m sphinx.cmd.quickstart
sudo port -f install py37-sphinx
sudo -H pip install sphinx_rtd_theme
# Python3 bin
export PATH="/opt/local/Library/Frameworks/Python.framework/Versions/3.7/bin:$PATH"

Issues

Readthedocs

pip install sphinx-rtd-theme

PyPi

sudo -H  pip3 install --upgrade twine wheel