Repolode
Enviar
readthedocs

readthedocs/readthedocs.org

Plataforma open source que compila, versiona e hospeda documentação automaticamente a partir de repositórios Git, com suporte a Sphinx e MkDocs.

Ver no GitHubSite
Estrelas
8,406
Forks
3,717
Issues abertas
383
Último commit
há 6 horas

O que é?

O Read the Docs hospeda a documentação de projetos e equipes open source. Ele busca a documentação em repositórios Git, compila usando ferramentas como Sphinx (reStructuredText) ou MkDocs (Markdown) e publica o resultado em um site hospedado.

A plataforma foi pensada para o fluxo de trabalho "Docs as Code": cada push no repositório pode iniciar uma nova compilação, mantendo a documentação publicada em sincronia com o código. Também é possível manter e disponibilizar várias versões da documentação de um projeto lado a lado.

Este repositório contém o código-fonte que alimenta o próprio serviço readthedocs.org. É um projeto Python, e o README aponta para documentações separadas sobre como configurar e gerenciar projetos e como contribuir com a base de código.

Recursos principais

  • 01Busca os arquivos-fonte da documentação diretamente em repositórios Git.
  • 02Compila projetos Sphinx e MkDocs automaticamente a cada push.
  • 03Mantém e disponibiliza várias versões da documentação.
  • 04Hospeda a documentação compilada em um site público ou privado.

Casos de uso

  • Hospedar a documentação pública de APIs ou bibliotecas de um projeto open source.
  • Publicar a documentação interna de uma equipe, atualizada a cada commit.
  • Disponibilizar documentação versionada para que os usuários consultem a versão correspondente à instalação.

Início rápido

  1. 1

    Cadastre-se no Read the Docs com sua conta do GitHub

  2. 2

    Quando o GitHub solicitar, conceda acesso aos seus repositórios

  3. 3

    Faça login, clique em "Adicionar projeto", selecione seu repositório e clique em "Continuar"

  4. 4

    Revise os detalhes do projeto, clique em "Avançar" e envie commits para atualizar a documentação automaticamente

Antes de usar

  • O serviço hospedado foi projetado para projetos de documentação, e hospedar toda a plataforma por conta própria exige um esforço considerável.
  • A base de código é uma aplicação Django de grande porte com muitas dependências, então configurar o ambiente de desenvolvimento local dá bastante trabalho.

Em coleções

Geradores de sites estáticos e ferramentas de documentação

Tópicos

#documentation#sphinx#mkdocs#python#docs-as-code#hosting#docs#sphinx-doc

Perguntas frequentes

O que é readthedocs.org?
Plataforma open source que compila, versiona e hospeda documentação automaticamente a partir de repositórios Git, com suporte a Sphinx e MkDocs. O Read the Docs hospeda a documentação de projetos e equipes open source. Ele busca a documentação em repositórios Git, compila usando ferramentas como Sphinx (reStructuredText) ou MkDocs (Markdown) e publica o resultado em um site hospedado.
readthedocs.org é gratuito? Qual é a licença?
readthedocs.org é open source sob a licença MIT. Confira os termos da licença antes de usá-lo em produtos comerciais.
readthedocs.org ainda é mantido?
Manutenção ativa. O último commit de readthedocs.org foi em 7 de nov. de 2026.
Para que posso usar readthedocs.org?
Hospedar a documentação pública de APIs ou bibliotecas de um projeto open source. Publicar a documentação interna de uma equipe, atualizada a cada commit. Disponibilizar documentação versionada para que os usuários consultem a versão correspondente à instalação.
Como instalar readthedocs.org?
Cadastre-se no Read the Docs com sua conta do GitHub Quando o GitHub solicitar, conceda acesso aos seus repositórios Faça login, clique em "Adicionar projeto", selecione seu repositório e clique em "Continuar" Revise os detalhes do projeto, clique em "Avançar" e envie commits para atualizar a documentação automaticamente
Onde consigo readthedocs.org?
O código-fonte e as instruções de instalação estão no GitHub: https://github.com/readthedocs/readthedocs.org

Resumo gerado por IA a partir do README do projeto. As estatísticas do GitHub são atualizadas diariamente.

Projetos relacionados