Skip to content

Instantly share code, notes, and snippets.

@ghoshbishakh

ghoshbishakh/GSOC 2016 report.md

Last active August 19, 2016 20:42
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save ghoshbishakh/0183e964e162350018e04bcd599b66ea to your computer and use it in GitHub Desktop.
Save ghoshbishakh/0183e964e162350018e04bcd599b66ea to your computer and use it in GitHub Desktop.
Download ZIP
Final report of the work done, Google Summer Of Code 2016
Raw
GSOC 2016 report.md

Links to all code:

[1] https://github.com/nipy/dipy_web/commits?author=ghoshbishakh All commits in dipy_web repository (the entire Django site.)

[2] dipy/dipy_web#2 Custom CMS with admin panel.

[3] dipy/dipy_web#10 Multiple documentation viewer, caching, SEO

[4] dipy/dipy_web#13 Dynamic gallery and tutorials page, analytics.

[5] dipy/dipy_web#15 GitHub stats visualization.

[6] dipy/dipy#1090 Documentation generation for command line interfaces.

[7] dipy/dipy#1082 Documentation uploading script for documentation of multiple versions.

[8] dipy/dipy#1091 Porting documentation generation scripts to python 3.

Currently the new Dipy website is hosted at http://dipy.herokuapp.com/.

Link to all blog posts: http://ghoshbishakh.github.io/blog/tag/gsoc/

Work Summary:

The goal of the project was to build a new Dipy website with custom CMS that supports multiple documentation versions, and to generate documentations automatically for both API and command line utilities.

We have met most of the goals that were initially proposed and now we have a new Dipy website that is dynamic, easily manageable and with many new features.

Goals successfully met:

In dipy_web repository:

  1. Custom content management system using Django. [2]
  2. Authentication and authorization system using GitHub API. [2]
  3. Auto-generated gallery page. [4]
  4. Auto-generated tutorials page. [4]
  5. Support for multiple versions of documentations. [3]
  6. Visualization of development stats using GitHub API. [5]
  7. Social media integration, search engine optimization, and analytics. [3],[4]

In dipy repository:

  1. Script to build and upload documentation. [7]
  2. Porting documentation generation scripts to python 3. [8]
  3. Basic documentation generation for command line utilities. [6]

Next Steps:

  1. Improvement in documentation generation for command line utilities.
  2. Bug fixes and improvements: #8, #14, #23
  3. Configuring build servers for automatic generation and uploading of documentation.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment