Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make documentation more accessible #52

Open
salkinium opened this issue Mar 19, 2020 · 3 comments
Open

Make documentation more accessible #52

salkinium opened this issue Mar 19, 2020 · 3 comments

Comments

@salkinium
Copy link
Member

salkinium commented Mar 19, 2020

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
Copy link
Member

rleh commented Mar 19, 2020

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
Copy link
Member

rleh commented Mar 19, 2020

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
Copy link
Member Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

2 participants