lndocs

Lamin site generator.


Install
pip install lndocs==0.3.0

Documentation

lndocs: Lamin static site generator

This is a command line documentation tool (currently) only meant for Lamin-related projects: If unaffiliated with Lamin, we recommend to not rely on lndocs.

  • Given our small team with limited bandwidth, we cannot offer support for documenting projects that are not related to Lamin.
  • We will likely make drastic changes to this package that are not going to be backward compatible without any warnings.
  • We might develop the package into a general-purpose docs builder longer into the future.

Install via:

pip install git+https://github.com/laminlabs/lndocs.git

Build the docs by running lndocs in the root of your project repository:

lndocs

Acknowledgements:

lndocs builds on docutils, Sphinx, Bootstrap, pydata-sphinx-theme, and several other open-source tools.