About ===== CLDomain is a Common Lisp domain for `Sphinx Documentation Generator`_. Sphinx is a mulit-language documentation tool. This project extends it's functionality to cover Common Lisp. The aim is to support documentation with the same ease as Sphinx would a Python project. Documentation is extracted from the various entity's documentation strings, loaded from ASDF systems and associated internal packages. Hyperspec is a cross referencing extension that supports linking to the `Hyperspec`. CLDomain is licensed under the `GPLv3`_. Please report any bugs in the `Mailing List`_. This documentation contains example of the generated documentation but if you want a more serious example `cl-git`_ is using it too. .. _Documentation: https://sphinxcontrib-cldomain.russellsim.org/ .. _cl-git: http://cl-git.russellsim.org/ .. _Sphinx Documentation Generator: https://www.sphinx-doc.org/ .. _Mailing List: https://lists.sr.ht/~rsl/sphinxcontrib-cldomain .. _GPLv3: https://www.gnu.org/licenses/gpl-3.0-standalone.html .. _Hyperspec: http://www.lispworks.com/documentation/HyperSpec/Front/index.htm .. toctree:: :maxdepth: 2 :caption: Topic Areas gettingstarted .. toctree:: :maxdepth: 2 :caption: Usage common packages variables functions generics clos-classes .. toctree:: :maxdepth: 1 :caption: Changelog changelog