Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Move Documentation to readthedocs

See original GitHub issue

Right now all the documentation for this library is in It’s getting pretty unwieldy at this point, and should really probably be moved into a hosted page somewhere.

I’ve used before, and it works pretty well. We’ll have to refactor the README documentation into sphinx documentation first, but that shouldn’t be too tricky.


  • refactor documentation into a docs/ folder, using sphinx
  • enable/connect readthedocs
  • update
    • to point to the hosted documentation
    • to only have a feature overview and basic quickstart
  • (maybe) update repo description with the docs link

Issue Analytics

  • State:open
  • Created 4 years ago
  • Comments:6 (4 by maintainers)

github_iconTop GitHub Comments

ghostcommented, Nov 29, 2019

I would like to suggest MKDocs instead. It uses markdown instead of reStructuredText, and it’s lighter and easier to configure. — a bit like this library vs. Celery.

Another selling point is that it comes with a command to automatically build and push the result to the gh-pages branch, so it effectively publishes the documentation to GitHub pages (of course, you can build it and post it to another place.)


sixhobbitscommented, Mar 20, 2022

Here’s a preview of what it could look like using MkDocs Material – a more modern theme of MkDocs that includes a lot of nice extras like search.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Transfer | Read the Docs
Transfer · Versions · Repository · Project Slug · Last Built · Maintainers · Badge · Tags · Short URLs.
Read more >
Read the Docs tutorial
In this tutorial you will create a documentation project on Read the Docs by importing a Sphinx project from a GitHub repository, tailor...
Read more >
Move documentation to · Issue #1 - GitHub
Hello @joemcbride, I've gone through the graphql-dotnet document ... I think we should move our documentation to If ...
Read more >
Move documentation to wiki or readthedocs or any other multi ...
The one page documentation is getting too large: it is very slow (unusable on a cell phone), the search often fails (for example...
Read more >
Move docs from readthedocs to Documenter.jl
Currently the Deconvolution.jl docs are hosted on readthedocs. Rather than using readthedocs, set up the repo to use Documenter.jl. A quick tutorial of...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Post

No results found

github_iconTop Related Hashnode Post

No results found