...
- If successful issues a RestAPI (webhook api at Readthedocs) to pull the new build into http://onap.readthedocs.io
The requirements documentation must follow the rules defined by the Documentation project: http://onap.readthedocs.io/en/latest/guides/onap-developer/how-to-use-docs/include-documentation.html#testing
- compliant with Doc8 https://pypi.python.org/pypi/doc8
Project Responsibilities
...
- Where our documentation needs to fit in the overall documentation structure, as well as
- The structure of our documents .(We need to clarify what a Document is)
- Chapters
- .rst files
- start with assuming one chapter per .rst file
- if chapters too big then chunk smaller by document sections
- objective is to keep manage-ably sized, coherent chunks of content together for review/commit purposes
- The structure of our documents should be reflected as within the repo structure of our project.
- directories
- all the .rst files of one document in one directory
- only one document per directory
- directories
...