Hello all,
I'm glad to announce availability of the page: https://complianceascode.readthedocs.io.
It contains the developer documentation of https://github.com/ComplianceAsCode/content/ Additionally, contains documentation of our Jinja macros and Python Modules. In future, it will have even more documentation.
With this new documentation hosting platform in place, we are deprecating the older Developer Guide https://github.com/ComplianceAsCode/content/blob/master/docs/manual/developer_guide.adoc. It will still exist for some time, but the preferred version is the ReadTheDocs.org one.
We needed a platform where we could scale and organize better the documentation as it only gets bigger.
If you would like to build the same documentation locally, follow the Sphinx build instructions on Building https://complianceascode.readthedocs.io/en/latest/manual/developer/02_building_complianceascode.html#building
Regards.
Hello all,
Be sure to check out this fresh blog post https://complianceascode.github.io/template/2021/01/19/developer-documentation.html that talks about the documentation integration with ReadTheDocs.org.
Best regards.
[1] https://complianceascode.github.io/template/2021/01/19/developer-documentati...
On Thu, Nov 12, 2020 at 12:48 PM Gabriel Gaspar Becker ggasparb@redhat.com wrote:
Hello all,
I'm glad to announce availability of the page: https://complianceascode.readthedocs.io.
It contains the developer documentation of https://github.com/ComplianceAsCode/content/ Additionally, contains documentation of our Jinja macros and Python Modules. In future, it will have even more documentation.
With this new documentation hosting platform in place, we are deprecating the older Developer Guide https://github.com/ComplianceAsCode/content/blob/master/docs/manual/developer_guide.adoc. It will still exist for some time, but the preferred version is the ReadTheDocs.org one.
We needed a platform where we could scale and organize better the documentation as it only gets bigger.
If you would like to build the same documentation locally, follow the Sphinx build instructions on Building
Regards.
--
Gabriel Gaspar Becker
Software Engineer
scap-security-guide@lists.fedorahosted.org
-
Gabriel Gaspar Becker