Skip to content

gurukamath/picklebuilder

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

95 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

README for Pickle Builder

Sphinx extension to pickle documents.

In itself, the extension is fairly straightforward -- it takes the parsed reST file from Sphinx and pickles it to a file.

Installing

Using pip

pip install picklebuilder

Usage

  • Set the builder as a extension in conf.py:

    extensions = ['picklebuilder.picklebuilder']
    
  • Run sphinx-build with target rpickle:

    sphinx-build -b rpickle -c . build/pickle
    

Further Reading

Feedback

The pickle builder is in a preliminary state. It's not (yet) widely used, so any feedback is particularly welcome.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 100.0%