Create ReadTheDocs documentation

[coding-to-music]

Create ReadTheDocs documentation

• Dimensions
• Visualizer
• Kits
• Creating Maps and game boards
• Concepts
• Strategy
• How-To
• Kaggle

[coding-to-music]

Technical features to consider

• Theme
• Right-side local TOC
• Dark Mode
• Sphinx
• Auto-generate the documentation by importing readme's at build time
• Auto-generate the API documentation and Classes
• Tabs for content including OS-specific topics or to help convey the story
• Material Design
• Sitemap.xml submissions so Bing and Google know you exist
• Meta information in each header so crawlers know the content
• Auto-generation of multiple languages

[coding-to-music]

Useful technical links for documentation

I recently created a few hundred pages on ReadTheDocs

Kinda a grab bag of every extension that does something mildly interesting. Tech stack for the site

General Computer Setup is pretty good. Advanced Computer Topics is interesting but it's an endless topic.

I stopped adding more pages because there were so many features I wanted to add and actually the whole thing needed to be automated - otherwise things get out of date and technical debt builds up. Without the right meta in headers people don't know the pages exist, so meta needs to be correct and auto generated and sitemaps sent to the search engines automatically upon changes. So for my needs I need automation, and the scale of this project would reward automation where possible.

I include some links here as they may be useful resources:

• Right-hand TOC
• Dark Mode - Change the colors of the Sphinx Read The Docs theme
• SEO learning resources
• Sphinx-copybutton - add a little “copy” button to the right of your code blocks
• Nicer looking tabs, show/hide blocks of text using sphinx extension sphinxcontrib-contentui
• readthedocs-embed Allows users to embed HTML documentation from any Read the Docs project
• Use templates
• Sphinx Gitstamp Generator Extension
• sphinx-git allows you to include excerpts from your git history within your documentation
• sphinxcontrib-mermaid - lets you create diagrams and visualizations using text and code
• Custom Google Analytics Reports and Alerts That Every Website Should Have
• mkdocs Material theme - right hand TOC, Material Design, dark mode