Skip to content

alchemy-fr/Documentation-Boilerplate

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

#Alchemy Documentation Boilerplate

This boilerplate is intended to be used by Alchemy developers to build documentation for project.

This script copy the boilerplate files to the directory and provides a consistent design for Alchemy Open-Source project documentation;

##Usage

./generator.sh <destination> [--force|-f] [--update|-u]

##Todo

##Done

  • Generate the documentation (write the doc to the directory, default is docs)
  • Enable the force option (force doc generation - overwrite - on the directory)
  • Enable the update option (update the doc - only overwrite base files)

The base files are all, except :

  • source/local_conf.py
  • _themes/static/main.js

##License

This generator is licensed under the MIT license

About

A sphinx documentation boilerplate for Alchemy open source projects

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published