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.

[DOC] - Create a static documentation site based on Readthedocs

See original GitHub issue

Description :

Create a static documentation site based on Readthedocs.
Support markdowm documents with the Recommonmark module.
Automatically triggering builds with Readthedocs’ webhook.
Use Readthedocs to bind our custom domain, such as doc.oss.chat.

Issue Analytics

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

Top GitHub Comments

1reaction

francis-ducommented, Mar 14, 2020

Readthedocs has many good features, such as multi-version management, multi-language support，etc…

0reactions

lijiaruicommented, Apr 2, 2020

Cool!

Top Results From Across the Web

Read the Docs: Home

Read the Docs simplifies technical documentation by automating building, versioning, and hosting for you. Build up-to-date documentation for the web, print, ...

Documentation Hosting Features - Read the Docs

Every project has a subdomain that is available to serve its documentation based on it's slug. If you go to <slug>.readthedocs.io , it...

Exploring Read The Docs - Medium

In this post, we'll go over what Read the Docs is in terms of a project, how Sphinx and MkDocs are used to...

MkDocs

Project documentation with Markdown. MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation.

Live Coding: Documentation w/ ReadTheDocs.org (RTFD)

Readthedocs.org allows for free hosting for documentation. You can have the documentation automatically generated from plain-text into HTML ...