Official Documentation for the Opal Framework
A project isn't complete without documenation. This is the official documentation for the Opal framework.
- Language Translations
- Frequently Asked Questions (FAQ)
- Screenshots
- Submit Issues
This documentation is published using Read the Docs. The Their tutorial is useful for getting up to speed
- The contents of the Opal documenation are in
docs/source - Locally generate the site:
sphinx-build -M html docs/source/ docs/build/
Read The Docs (RTD) technically supports both Markdown and reStructuredText (reST). For this project, I've chosen the latter. Not only is reStructuredText more robust, but it's also more unified. There are several flavors or dialects of Markdown. I hadn't used reST before. So I decided to use reST for this project. So all Opal Documentation is written in reStructuredText.
- Semantic Versioning
- GitHub Markdown
- Contributing Guidelines
- Changelog
- Humans TXT
- Robots TXT
- Git Ignore Generator
- Open Source Licenses
- Project Creator: Andrew Woods