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.
To start using Yaydoc, make sure you have all of the following:
source) containing all the markup files
Note: For advanced configurations, include an
index.rstfile which contains toctrees to link the various documents.
.yaydoc.ymlfile to git, commit and push, to trigger the Yaydoc build process.
Note: Yaydoc only runs builds on the commits you push after you’ve registered your repository in Yaydoc. Ensure that the repository is enabled from the its settings at Yaydoc.
_staticdirectory placed under source.
This is an Open Source project and we would be happy to see contributors who report bugs and file feature requests submitting pull requests as well. Please report issues here https://github.com/fossasia/yaydoc/issues
This project is currently licensed under the GNU General Public License v3. A copy of LICENSE.md should be present along with the source code. To obtain the software under a different license, please contact FOSSASIA.