Make documentation more accessible

modm-io / lbuild

lbuild: a generic, modular code generator in Python 3

https://pypi.org/project/lbuild

BSD 2-Clause "Simplified" License

37 stars 12 forks source link

Make documentation more accessible #52

Open salkinium opened 4 years ago

salkinium commented 4 years ago

Currently the Readme contains the whole documentation, which is fairly complete, but not super useful to access.

Wishlist:

Have a proper website at lbuild.modm.io or readthedocs with overview, install instructions, development instructions etc.
Split the current Readme documentation into smaller and searchable modules.
Find a way to install the docs with pip install lbuild
Manpages? or at least a better lbuild -h.

rleh commented 4 years ago

Find a way to install the docs with pip install lbuild

Once the documentation is available on https://lbuild.modm.io/ I don't think we need the documentation in a pip package. lbuild -h could then refer to the website.

rleh commented 4 years ago

For a start: What do you think about showing the current README on https://lbuild.modm.io/ and pointing to a (non-empty) ReadTheDocs there?

salkinium commented 4 years ago

Yes, just currently working on too many things at once, hence opening this issue.