Skip to content
This repository has been archived by the owner on Feb 28, 2020. It is now read-only.

plone/mr.gutenberg

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

29 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Mr.Gutenberg

is a buildout recipe which will install and setup Sphinx following the Documentation Guidelines of the Plone Foundation for your Project. The aim of mr.gutenberg is to make documentation so painless as possible for developers.

What it does:

mr.gutenberg will install Sphinx and will do the setup. You will end up with a folder called ''docs'' in your buildout, this folder contains Sphinx and all related files and config. In addition you will find some boilerplate templates, which make it easier to write documentation. mr.gutenberg will create an index.rst which will be filled with base data out of your setup.py (like the Author, Description and so on).

Options:

Till we fetch these from setup.py we will have to configure some options in your buildout.cfg.

project = plone.app.welikedocs

author = Sven

This is pretty much WIP and not fully working yet !!!

About

helps you writing docs

Resources

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

 

Packages

No packages published

Languages