Skip to content

40ants/cldomain

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
src
 
 
t
 
 
 
 
 
 
 
 
 
 
 
 

sphinxcontrib.cldomain

https://travis-ci.org/40ants/cldomain.svg?branch=master

Cldomain is a command line utility, used by sphinxcontrib.cldomain extension to generate beautiful documentation for Common Lisp programms. It extracts documentation strings from Lisp systems and put them into a JSON file.

Reasoning

Most Lisp system's documentatin sucks. Sphinx_ is a very good and stable tool, used for documenting many software libraries. Though originall Sphinx_ was written to document Python libraries, it is easily extendable to write any kind of documents. Based on reStructured text markup, sphinx based documentation is very readable and it is easy to use internal hyperlinks between different documents and code.

Usage

Install cldomain using roswell:

ros install 40ants/cldomain

How to build documentation

To build documentation, you need a Sphinx. It is documentaion building tool written in Python.

To install it, you need a virtualenv. Read this instructions how to install it.

Also, you'll need a cl-launch. It is used by documentation tool to run a script which extracts documentation strings from lisp systems.

Run these commands to build documentation:

virtualenv env
source env/bin/activate
pip install -r docs/requirements.txt
invoke build_docs

These commands will create a virtual environment and install some python libraries there. Command invoke build_docs will build documentation and upload it to the GitHub, by replacing the content of the gh-pages branch.

About

Helper for sphinxcontrib.cldomain to collect docstrings from Lisp systems.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published