Welcome to my Sphinx with github webpage tutorials! In those tutorials, you will learn how to use Sphinx to create .html and .pdf and how to hookup your Sphinx webpage to github. The PDF version can be downloaded from HERE.

Contents

• 1. Preface
  • 1.1. About
  • 1.2. Motivation for this tutorial
  • 1.3. Feedback and suggestions
• 2. Introduction
  • 2.1. Sphnix: Python Documentation Generator
  • 2.2. reStructured Text
  • 2.3. Latex Document Preparation System
• 3. Packages Installation
  • 3.1. Python Installation
  • 3.2. Sphinx Installation
  • 3.3. Latex Installation
• 4. Sphinx Configuration
  • 4.1. General HTML Configuration
  • 4.2. General LaTex Configuration
  • 4.3. Full conf.py Script
  • 4.4. General Documentation Generator Configuration
  • 4.5. Full docgen.py Script
• 5. reStructuredText Markup
  • 5.1. reStructuredText Primer
  • 5.2. Roles
  • 5.3. Directives
• 6. API Example
  • 6.1. rnorm
  • 6.2. dnorm
  • 6.3. runif
  • 6.4. T-test
• 7. Publishing on Github
  • 7.1. Create reStructuredTexts
  • 7.2. Create Repository on Github
  • 7.3. Commit reStructuredTexts folder to Repository
  • 7.4. Setup Github Pages on Github
• 8. Main Reference
• 9. Appendix: My LaTex Cheat Sheet