Skip to content

Use Read The Docs for documentation #18

@arnodelorme

Description

@arnodelorme
pip install sphinx
sphinx-quickstart
  • Modify index.rst and other .rst files inside the docs/ directory.
  • Sign up for https://about.readthedocs.com/?ref=readthedocs.org
  • Import the GitHub repo and Grant Read the Docs permission to access your repo
  • Create a .readthedocs.yml file in your project’s root directory for build configuration
version: 2
formats: ["htmlzip", "pdf"]
sphinx:
  configuration: docs/conf.py
python:
  install:
    - requirements: docs/requirements.txt
  • Access documentation at https://your-project.readthedocs.io/
  • Under Domains in read the docs, add your custom domain (e.g., docs.yourdomain.com).
  • Update Your Domain’s DNS Records and add a CNAME record pointing your domain (e.g., docs.yourdomain.com) to: readthedocs.io (If you are using a root domain (e.g., yourdomain.com), you may need to use an A record pointing to Read the Docs’ IP address).
  • Enable HTTPS. Read the Docs automatically provides free HTTPS via Let’s Encrypt. You may need to wait for the SSL certificate to be issued.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions