663e420643
Switch to openstackdocstheme 2.2.0 and reno 3.1.0 versions. Using these versions will allow especially: * Linking from HTML to PDF document * Allow parallel building of documents * Fix some rendering problems Update Sphinx version as well. Set openstackdocs_pdf_link to link to PDF file. Note that the link to the published document only works on docs.openstack.org where the PDF file is placed in the top-level html directory. The site-preview places the PDF in a pdf directory. Set openstackdocs_auto_name to use 'project' as name. Change pygments_style to 'native' since old theme version always used 'native' and the theme now respects the setting and using 'sphinx' can lead to some strange rendering. Remove docs requirements from lower-constraints, they are not needed during install or test but only for docs building. openstackdocstheme renames some variables, so follow the renames before the next release removes them. A couple of variables are also not needed anymore, remove them. Add openstackdocstheme options to api-ref. Change-Id: I0cf71327ca5d9da1d88a826225374c8801849c36
Team and repository tags
OpenStack Designate
Designate is an OpenStack project, providing DNSaaS.
IRC: #openstack-dns @ freenode
Installation: https://docs.openstack.org/designate/latest/
API
To learn how to use Designate's API, consult the documentation available online at:
For more information on OpenStack APIs, SDKs and CLIs in general, refer to:
Development
Designate follows the OpenStack Gerrit Workflow
Setup
Setup a working environment:
git clone https://opendev.org/openstack/designate
cd designate
virtualenv .venv
. .venv/bin/activate
pip install -r requirements.txt -r test-requirements.txt
pip install -e .Building Docs
To build the documentation from the restructured text source, do the following:
tox -e docsNow point your browser at doc/build/html/index.html (the official documentation is published to docs.openstack.org by the maintainers.
Testing
Execute all unit tests
tox -e py36Execute only backend tests
tox -e py36 -- unit.backendExecute only a single test
tox -e py36 -- unit.backend.test_pdns4.PDNS4BackendTestCase.test_create_zone_successContributing
Install the git-review package to make life easier
pip install git-reviewBranch, work, & submit:
# cut a new branch, tracking master
git checkout --track -b bug/id origin/master
# work work work
git add stuff
git commit
# rebase/squash to a single commit before submitting
git rebase -i
# submit
git-reviewOther Information
- Free software: Apache license
- Documentation: https://docs.openstack.org/designate/latest/
- Release notes: https://docs.openstack.org/releasenotes/designate/
- Source: https://opendev.org/openstack/designate
- Bugs: https://bugs.launchpad.net/designate
- Blueprints: https://blueprints.launchpad.net/designate