Welcome to Doc Project’s documentation!

Hello World!

Contents

• A case for documentation
  • Overview
  • Documenting our own software
  • Documenting others’ package
  • Documentation options
  • Why ReadTheDocs?
  • Rest of the documentation
• Getting started
  • Introduction
  • Install ReadTheDocs prerequisites
    • Python
    • Sphinx
  • Creating a documentation project
  • Visual Studio Code
  • Apply the ReadTheDocs.io theme
• The reStructuredText markup syntax
  • Introduction
  • The table of contents tree and document sections
    • The toctree
    • Sections and headings
  • Text formatting
  • Lists
    • Numbered lists
    • Itemised lists
    • Nested lists
  • Admonitions
  • Images
  • Code Samples
  • Tables
    • list-table
    • csv-table
  • Hyperlinks
    • Hyperlink an URL
    • Hyperlink a document within the project
    • Hyperlink a spot on a document within the project
• Automating workflow
  • Introduction
  • Git and GitHub
  • Create and load GitHub repository for the source code
  • Set up ReadTheDocs hosting
  • Continuous integration / continuous delivery
  • Setting up CI/CD on ReadTheDocs
  • Pull requests
  • Configure GitHub to require Pull requests to Master
  • Submit a Change via a Pull request
  • Approve and Merge the Pull request
  • Summary
• Beyond reStructuredText
  • Introduction
  • Custom CSS
  • Why Custom CSS
  • Add Custom CSS to the Project
  • Add markdown support and a markdown document
  • Versions
  • Enable versions with a long-lived branch
  • Verify version behaviour
  • Summary
• Project version numbering system
  • Project level specification
    • <DocType> (optional) (WIP)
    • <Approved>
    • <StructuralChangeDraft>
    • <EditorialDraft>
  • Document level specification
    • <Approved>
    • <StructuralChangeDraft>
    • <EditorialDraft>
  • Filename convention
    • <IterationCode> (optional)
    • Version level number
    • <Procedure> suffix
• css