Docs! Yay! http://yaydoc.org
JavaScript Python HTML Shell CSS
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github Fixes #52 Add Issue and PR Templates (#54) Jun 1, 2017
backend Fixes 410: generic smtp mail service added (#418) Oct 20, 2017
bin Fixes #116 Organising code of the WebUI (#117) Jun 14, 2017
docs Fixes 410: generic smtp mail service added (#418) Oct 20, 2017
kubernetes Fixes #425 Automatic deployment of Yaydoc master and Yaydoc staging Oct 20, 2017
middleware Fixes #360 Use auth middleware and move github requests (#363) Aug 12, 2017
model Fixes #358 Allow user to specify branch to generate docs (#424) Oct 20, 2017
modules Fixes #426 Added unittest for markdown+ (#429) Oct 20, 2017
public Fixes #435: style added to make the avatar of same size (#437) Oct 20, 2017
routes Fixes #430 Update Github Access Token on login (#431) Oct 20, 2017
tests Fixes #426 Added unittest for markdown+ (#429) Oct 20, 2017
util Fixes #430 Update Github Access Token on login (#431) Oct 20, 2017
views Fixes #435: style added to make the avatar of same size (#437) Oct 20, 2017
.dockerignore Setup for docker environment (#353) Aug 9, 2017
.env.example Fixes #400 Document steps for generic installation (#401) Aug 18, 2017
.eslintrc.js Fixes #86: eslint config added (#99) Jun 11, 2017
.gitignore Fixes #372 Add options to modify behaviour of autoindex (#383) Aug 15, 2017
.pylintrc Fixes #86 : unwanted pylint config modified (#91) Jun 9, 2017
.travis.yml Fixes #425 Automatic deployment of Yaydoc master and Yaydoc staging Oct 20, 2017
.yaydoc.yml Fixes #402 Exclude git push command logs (#403) Oct 20, 2017
Dockerfile Fixes #387 Add openjdk8 in Dockerfile for javadocs (#398) Aug 18, 2017
LICENSE Initial commit May 7, 2017
Procfile Fixes #119 Configuration to deploy yaydoc to Heroku (#124) Jun 19, 2017
README.md Update README.md Oct 20, 2017
app.js Fixes #430 Update Github Access Token on login (#431) Oct 20, 2017
app.json Fixes 410: generic smtp mail service added (#418) Oct 20, 2017
generate.sh Fixes #393 add swagger, twitter and rss to autoindex (#409) Oct 20, 2017
ghpages_deploy.sh Fixes #402 Exclude git push command logs (#403) Oct 20, 2017
heroku_deploy.sh Fixes #382 Resolve link to images of subprojects (#392) Oct 20, 2017
logging.sh Fixes #382 Resolve link to images of subprojects (#392) Oct 20, 2017
multiple_api_docs.sh Fixes #372 Add options to modify behaviour of autoindex (#383) Aug 15, 2017
multiple_generate.sh Fixes #393 add swagger, twitter and rss to autoindex (#409) Oct 20, 2017
package.json Fixes 410: generic smtp mail service added (#418) Oct 20, 2017
requirements.txt Fixes #411 Pin python dependencies to specific version (#416) Oct 20, 2017
surge_deploy.sh Fixes #369: added support to deploy preview to surge (#373) Aug 13, 2017
web.js Fixes #74 Enable deployment of docs to Heroku (#193) Jun 29, 2017

README.md

Yaydoc

Development Build Status Master Build Status Join the chat at https://gitter.im/fossasia/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

Getting started

Prerequisites

To start using Yaydoc, make sure you have all of the following:

Note: For advanced configurations, include an index.rst file which contains toctrees to link the various documents.

To get started with Yaydoc

  1. Using your Github account, sign in to yaydoc.org and accept the Github access permissions confirmation
  2. Once you’re signed in to Yaydoc, go to your dashboard and register the repository you want to build your documentation from.
  3. Add a .yaydoc.yml file to the root of your repository to define rules and variables for Yaydoc's build process
  4. Add the .yaydoc.yml file to git, commit and push, to trigger the Yaydoc build process.
  5. 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. Ensure that 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 _static directory placed under source.

Deployment

Deploy

Contributions, Bug Reports, Feature Requests

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

License

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.