b8a2bb3b27
Implements `make docs` command to create rtd-themed docs using Sphinx from the existing Markdown documents in the docs directory. Changes the `get-modules` command to `depend` to more closely match OpenStack guidelines in [0]. Adds `fmt` command as specified in [0], currently referencing the `lint` command. Adds `godoc` command that will host a local godoc server instance with a link directly to airshipctl technical documentation. Adds `releasenotes` commands specified in [0], currently noted as "TODO". Adds `images` command as found in other Airship projects, referencing `docker-image`. [0] https://governance.openstack.org/tc/reference/pti/golang.html Change-Id: I134fc2c2714bce6d23dc9cf8b86c3016d68def7e
18 lines
404 B
Plaintext
18 lines
404 B
Plaintext
# The order of packages is significant, because pip processes them in the order
|
|
# of appearance. Changing the order has an impact on the overall integration
|
|
# process, which may cause wedges in the gate later.
|
|
|
|
# Documentation
|
|
sphinx>2.1.0
|
|
oslosphinx>=4.7.0 # Apache-2.0
|
|
sphinx_rtd_theme
|
|
|
|
# UML image generation
|
|
plantuml
|
|
|
|
# Releasenotes
|
|
reno>=2.5.0 # Apache-2.0
|
|
|
|
# Sphinx markdown extension
|
|
recommonmark
|