Skip to content

Instantly share code, notes, and snippets.

@poonai

poonai/GSoC17finalReportBalajiR.md

Last active September 2, 2017 09:55
Show Gist options
  • Save poonai/86c1e67798da6583f97627fbd2f427ed to your computer and use it in GitHub Desktop.
Save poonai/86c1e67798da6583f97627fbd2f427ed to your computer and use it in GitHub Desktop.
Download ZIP
Final Project Report for GSoC 2017 - sch00lb0y
Raw
GSoC17finalReportBalajiR.md

Google Summer of Code 2017 Final Submission Report

This GSoC, I worked on the Documentation project under FOSSASIA, called Yaydoc. Yaydoc is an automated documentation generation and deployment project that geneates and deploys documentation for a project hosted on Github at each and every commit made to its repository.

Outcome of my contribution:

  • Generate API documentation using Javadocs
  • Deploy documentation website to Github Pages
  • Register repositories for continuous integration
  • Enable-Disable the build process repository from Yaydoc
  • Register repositories as sub-projects under a single project to generate a cumulative website
  • Continous integration for the sub project repositories
  • User can see the preview of the documentation after documetation generation
  • Test case added for generator script
  • Sphinx extension for RSS feed
  • Sphinx extension for loklak timeline
  • Sphinx SUSI AI theme
  • Surge preview deployment
  • CI Status of the documentaion build in the Pull Request.

Screenshots

Documentation Generator Dashboard CI Setting
Documentation Generator Dashboard CI Setting

My contributions

fossasia/yaydoc

Deployment

Additional Links

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment