Skip to content

dmick/ayni

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

57 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ayni

A webservice with three different components to aid in proper documentation ordering:

  1. An HTTP API that serves JSON pointing to the various different versions of documentation available and its URLs.
  2. A dynamically generated Nginx file that maps URLs to the proper (current) versions of a project(s) documentation.
  3. A JavaScript library that should be injected into the Sphinx theme that understands how to talk to the exposed HTTP API and display a navigation menu to move to different documentation versions.

The name

From wikipedia:

"Ayni (Quechua, also spelled Ayniy or Aini) is a traditional form of mutual help practiced in indigenous communities (ayllu) in the Andes. Ayni means proper relationship. Member of a community help another member for private purposes when support is needed, e.g. in house construction or agricultural works."

Ayni is here to help documentation help others, by properly organizing it and showing the right path to the correct doc destination.

About

A Sphinx document version handler

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 89.9%
  • JavaScript 8.0%
  • CSS 2.1%