mirror of
https://github.com/akai-katto/dandere2x.git
synced 2026-03-31 11:01:03 +02:00
213 lines
5.1 KiB
ReStructuredText
213 lines
5.1 KiB
ReStructuredText
Read the Docs: Documentation Simplified
|
|
=======================================
|
|
|
|
.. meta::
|
|
:description lang=en: Automate building, versioning, and hosting of your technical documentation continuously on Read the Docs.
|
|
|
|
|
|
`Read the Docs`_ simplifies software documentation
|
|
by automating building, versioning, and hosting of your docs for you.
|
|
Think of it as *Continuous Documentation*.
|
|
|
|
Never out of sync
|
|
Whenever you push code to your favorite version control system,
|
|
whether that is Git, Mercurial, Bazaar, or Subversion,
|
|
Read the Docs will automatically build your docs
|
|
so your code and documentation are always up-to-date.
|
|
|
|
Multiple versions
|
|
Read the Docs can host and build multiple versions of your docs
|
|
so having a 1.0 version of your docs and a 2.0 version
|
|
of your docs is as easy as having a separate branch or tag in your version control system.
|
|
|
|
Free and open source
|
|
Read the Docs is free and open source and hosts documentation
|
|
for nearly 100,000 large and small open source projects
|
|
in almost every human and computer language.
|
|
|
|
.. _Read the docs: http://readthedocs.org/
|
|
|
|
|
|
First steps
|
|
-----------
|
|
|
|
Are you new to software documentation
|
|
or are you looking to use your existing docs with Read the Docs?
|
|
Learn about documentation authoring tools such as Sphinx and MkDocs
|
|
to help you create fantastic documentation for your project.
|
|
|
|
* **Getting started**:
|
|
:doc:`With Sphinx <intro/getting-started-with-sphinx>` |
|
|
:doc:`With MkDocs <intro/getting-started-with-mkdocs>`
|
|
|
|
* **Importing your existing documentation**:
|
|
:doc:`Import guide <intro/import-guide>`
|
|
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:hidden:
|
|
:caption: First steps
|
|
|
|
intro/getting-started-with-sphinx
|
|
intro/getting-started-with-mkdocs
|
|
|
|
intro/import-guide
|
|
|
|
|
|
Getting started with Read the Docs
|
|
-----------------------------------
|
|
|
|
Learn more about configuring your automated documentation builds
|
|
and some of the core features of Read the Docs.
|
|
|
|
* **Overview of core features**:
|
|
:doc:`features`
|
|
|
|
* **Configure your documentation**:
|
|
:doc:`Configuration reference <config-file/index>` |
|
|
:doc:`webhooks` |
|
|
:doc:`badges` |
|
|
:doc:`Custom domains <custom_domains>`
|
|
|
|
* **Connecting with GitHub, BitBucket, or GitLab**:
|
|
:doc:`Connecting your account <connected-accounts>`
|
|
|
|
* **Read the Docs build and versioning process**:
|
|
:doc:`Build process <builds>` |
|
|
:doc:`Handling multiple docs versions <versions>`
|
|
|
|
* **Troubleshooting**:
|
|
:doc:`support` |
|
|
:doc:`Frequently asked questions <faq>`
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:hidden:
|
|
:caption: Getting started
|
|
|
|
features
|
|
|
|
config-file/index
|
|
webhooks
|
|
badges
|
|
custom_domains
|
|
|
|
connected-accounts
|
|
|
|
builds
|
|
versions
|
|
|
|
support
|
|
faq
|
|
|
|
|
|
Advanced features of Read the Docs
|
|
----------------------------------
|
|
|
|
Read the Docs offers many advanced features and options.
|
|
Learn more about these integrations and how you can get the most
|
|
out of your documentation and Read the Docs.
|
|
|
|
* **Advanced project configuration**:
|
|
:doc:`subprojects` |
|
|
:doc:`Single version docs <single_version>` |
|
|
:doc:`Privacy levels <privacy>`
|
|
|
|
* **Multi-language documentation**:
|
|
:doc:`Translations and localization <localization>`
|
|
|
|
* **Redirects**:
|
|
:doc:`User defined redirects <user-defined-redirects>` |
|
|
:doc:`Automatic redirects <automatic-redirects>`
|
|
|
|
* **Topic specific guides**:
|
|
:doc:`How-to guides <guides/index>`
|
|
|
|
* **Extending Read the Docs**:
|
|
:doc:`REST API <api/index>`
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:hidden:
|
|
:glob:
|
|
:caption: Advanced features
|
|
|
|
subprojects
|
|
single_version
|
|
privacy
|
|
|
|
localization
|
|
|
|
user-defined-redirects
|
|
automatic-redirects
|
|
|
|
guides/index
|
|
|
|
api/index
|
|
|
|
|
|
The Read the Docs project and organization
|
|
------------------------------------------
|
|
|
|
Learn about Read the Docs, the project and the company,
|
|
and find out how you can get involved and contribute to the development and success
|
|
of Read the Docs and the larger software documentation ecosystem.
|
|
|
|
* **Getting involved with Read the Docs**:
|
|
:doc:`Contributing <contribute>` |
|
|
:doc:`roadmap` |
|
|
:doc:`gsoc` |
|
|
:doc:`Code of conduct <code-of-conduct>`
|
|
|
|
* **Policies & Process**:
|
|
:doc:`security` |
|
|
:doc:`Privacy policy <privacy-policy>` |
|
|
:doc:`DMCA takedown policy <dmca/index>` |
|
|
:doc:`Policy for abandoned projects <abandoned-projects>` |
|
|
:doc:`Release notes & changelog <changelog>`
|
|
|
|
* **The people and philosophy behind Read the Docs**:
|
|
:doc:`Team <team>` |
|
|
:doc:`Open source philosophy <open-source-philosophy>` |
|
|
:doc:`Our story <story>`
|
|
|
|
* **Financial and material support**:
|
|
:doc:`advertising/index` |
|
|
:doc:`Sponsors <sponsors>`
|
|
|
|
* **Read the Docs for Business**:
|
|
:doc:`Support and additional features <commercial/index>`
|
|
|
|
* **Running your own version of Read the Docs**:
|
|
:doc:`Private installations <custom_installs/index>`
|
|
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:hidden:
|
|
:caption: About Read the Docs
|
|
|
|
contribute
|
|
roadmap
|
|
gsoc
|
|
code-of-conduct
|
|
|
|
security
|
|
privacy-policy
|
|
dmca/index
|
|
abandoned-projects
|
|
changelog
|
|
|
|
team
|
|
open-source-philosophy
|
|
story
|
|
|
|
advertising/index
|
|
sponsors
|
|
|
|
commercial/index
|
|
|
|
custom_installs/index
|
|
|