README.rst

Documentation Tutorial

Contents

• Documentation, why???
• Reference Links
• Top Projects Documenting using reST
• Videos for Learning
• Git Man

Documentation, why???

1. New Users/Consumers
2. How to use it properly (how to configure it)
3. Not breaking the code for new Developers/Authors (+tests)
4. avoid questions (repeating QA)

Tip

A README should contain only the necessary information for developers to get started using and contributing to your project. Longer documentation is best suited for wikis.

!DANGER!

it's not recommended at all but if you can'ttttttt get to the point with reST go with html Stack Overflow

sphinx-quickstart docs make html reStructuredText plugin for vscode index.html inside _build

Reference Links

• Sourceforge Full Documentation

  • Sourceforge
  • Detailed Documentation from Sourceforge
  • Quick Reference from Sourceforge

• Sphinx
• Sublime and sphinx guide
• Read the Docs tutorial
• Make a README
• Awsome README
• Well Documented project with rst
• Basic README tutorial
• Basic README tutorial
• Using Git History for writing Tutorials
• Universal Document Converter
• Deploying Sphinx Documentation to GitHub Pages
• Coderefinery
• Making a PyPI-friendly README
• Typo3
• reStructuredText Primer
• Basic Reference
• Basic reST syntax and cheatsheet
• GitHub Pages
• GitHub Wiki
• GitHub README
• Making README readable
• Documenting your project with wikis
• The reStructuredText Cheat Sheet: Syntax Reminders
• reStructuredText Extension for Visual Studio Code
• rst cheatsheet

Top Projects Documenting using reST

• Django
• Flask
• Conda
• Python
• Open Stack

Videos for Learning

• Intro
• Basic Playlist
• PyCon US
• Sphinx for Python Documentation
• Pluralsight ReadTheDocs + Sphinx + GitHub + CI-CD

Git Man

• Git Doc