README_NOTES.md

Quick Links:

• Pricing: Community Editions is always free but shows ads: Click here
• Used in projects:
  • ❤️ Cloud-init documentation: Click here
    • Features:
      • Search by using key /
      • Export as EPUB, PDF, HTML (complete site)) by clicking on bottom-right "Read the Docs" button on the site.

Demo of Read the docs (with Alex Vishwa)

Docs are written in reStructuredText format e.g., check files - docs/index.rst and docs/api.rst in this project.

• Docs are automatically pushed as you as you commit to this github repo and web hooks from readthedocs automatically deploys your new changes.

Published to - https://python-docs1.readthedocs.io

Src: Click here

Read the Docs tutorial, containing following files:

• .readthedocs.yaml: Read the Docs configuration file. Required.

• README.rst: Description of the repository.

• pyproject.toml: Python project metadata that makes it installable. Useful for automatic documentation generation from sources.

• lumache.py: Source code of the fictional Python library.

• docs/: Directory holding all the fictional Python library documentation in reStructuredText

  • the Sphinx configuration docs/source/conf.py and
  • the root document docs/source/index.rst.

What is reStructuredText? be concise. (ChatGPT)

reStructuredText (reST) is a lightweight markup language used for writing plain text documents with simple syntax. It is commonly used for documentation in Python projects, such as README files and Sphinx-based documentation. It supports features like headings, lists, hyperlinks, code blocks, and directives to generate formatted output like HTML, PDF, or LaTeX.