berth

Commit Graph

Author	SHA1	Message	Date
Roman Gorshunov	67372bade2	Set up publishing of docs Set up publishing of docs to the readthedocs. Change-Id: If42d4fa5937ab8edd0bacb20534328db8f1df216	2018-09-28 19:22:40 +02:00
Felipe Monteiro	a821aeff00	Berth documentation via build_sphinx. This PS adds tooling and automation to automatically generate Berth's documentation into feature-rich HTML pages that can be hosted. To run the documentation job, simply execute: tox -e docs Future docs should be written using the style described at http://www.sphinx-doc.org/en/stable/markup/code.html and located in berth/docs/source This PS also adds basic building blocks required by most any Python project: * test-requirements.txt * requirements.txt * setup.cfg * setup.py * added more filters to .gitignore Change-Id: I792b0244ce9909d70283730a29545304311c6dbc	2017-10-06 15:07:07 -04:00

Author

SHA1

Message

Date

Roman Gorshunov

67372bade2

Set up publishing of docs

Set up publishing of docs to the readthedocs.

Change-Id: If42d4fa5937ab8edd0bacb20534328db8f1df216

2018-09-28 19:22:40 +02:00

Felipe Monteiro

a821aeff00

Berth documentation via build_sphinx.

This PS adds tooling and automation to automatically generate
Berth's documentation into feature-rich HTML pages that can
be hosted.

To run the documentation job, simply execute:

    tox -e docs

Future docs should be written using the style described at
http://www.sphinx-doc.org/en/stable/markup/code.html and
located in berth/docs/source

This PS also adds basic building blocks required by most any
Python project:

  * test-requirements.txt
  * requirements.txt
  * setup.cfg
  * setup.py
  * added more filters to .gitignore

Change-Id: I792b0244ce9909d70283730a29545304311c6dbc

2017-10-06 15:07:07 -04:00

2 Commits