Sandbox¶
Setup¶
Those commands will get you started with a sandboxed development environment.
After invoking poe check
, and observing the software tests succeed, you
should be ready to start hacking.
git clone https://github.com/panodata/sphinx-design-elements
cd sphinx-design-elements
python3 -m venv .venv
source .venv/bin/activate
pip install --editable=.[develop,docs,test]
poe check
Software tests¶
For running the software tests after setup, invoke poe check
.
Optionally, activate the virtualenv, if you are coming back to
development using a fresh terminal session.
source .venv/bin/activate
poe check
Documentation¶
In order to build the documentation, invoke poe docs-html
.
poe docs-html
In order to continuously rebuild the documentation, while editing it,
invoke poe docs-autobuild
.
poe docs-autobuild
Edit source code¶
In order to edit or inspect the CSS stylesheet rules, head over to
compiled/style.css
. For editing or inspecting the directive- and
role-implementations, see gridtable.py
, infocard.py
, and tag.py
.
Releasing¶
# Install a few more prerequisites.
pip install --editable=.[release]
# Designate a new version.
git tag v0.1.0
git push --tags
# Build package, and publish to PyPI.
poe release