Yaydoc¶
Yaydoc is an automated documentation generation and deployment project that generates documentation for its registered repositories on each commit and deploys it to Github Pages.
Communication¶
- Please join our mailing list to discuss questions regarding the project: https://groups.google.com/forum/#!forum/yaydoc
- Our chat channel is on Gitter here: gitter.im/fossasia/yaydoc
Getting started¶
Prerequisites¶
To start using Yaydoc, make sure you have all of the following:
GitHub login
Project hosted as a repository on GitHub
Project containing a directory (
source) containing all the markup filesNote: For advanced configurations, include anindex.rstfile which containstoctrees to link the various documents.
To get started with Yaydoc¶
Using your Github account, sign in to yaydoc.org and accept the Github access permissions confirmation
Once you’re signed in to Yaydoc, go to your dashboard and register the repository you want to build your documentation from.
Add a .yaydoc.yml file to the root of your repository to define rules and variables for Yaydoc’s build process
Add the
.yaydoc.ymlfile to git, commit and push, to trigger the Yaydoc build process.Check the logs for your repository to see if the documentation generation and deployment process passes or fails.
Note: Yaydoc only runs builds on the commits you push after you’ve registered your repository in Yaydoc. Ensurethat the repository is enabled from the its settings at Yaydoc.
Known limitations¶
- If you use embedded html in markdown or reStructuredText, any static
content such as images, javascript referred from it should be present
in a
_staticdirectory placed under source.
Deployment¶
