Logo
latest

Getting started

  • Introduction
    • Overview
    • Requirements
  • Installation
    • Python
    • Pip
    • Virtual environments
    • Godot
    • Script files
      • For extracting information from Godot
      • For creating the .rst files
      • Downloading the files
        • With git
        • Without git
    • gdscript2rest
    • godot-api-refs
    • Sphinx
    • Sphinx extensions
      • sphinx-rtd-theme
      • sphinx-notfound-page
      • sphinx-tabs
  • API Creation
    • Comment Godot script files
      • Enabling a script file for Commenting
      • Format of comments
      • What can be documented?
      • What isn't documented
      • Example Script file
      • Example reStructuredText file
    • Linking user docs to Godot help files
    • Automatic method
    • Manual method
      • Create the reference.json file
        • 1. From within the Godot editor
        • 2. From the command line
      • Generate the API reStructuredText files
  • Document Project Setup
    • Create project root and virtual environment
    • Setting Up Sphinx Environment
      • Install Sphinx
      • Install additional modules
    • Setting Up the Project Structure
    • Choosing an IDE
      • Setting Up VSCode
        • Install VSCode
        • Install Extensions
    • No preview showing
    • Configuring Sphinx
      • Setting up conf.py
        • Basic changes
        • Additional enhancements
        • Advanced options
    • Add gdscript2rst scripts
  • Creating the project documentation
    • Setting up the documentation folder
    • Creating the Sample Godot Project
    • Build Initial Documentation
    • Next steps
      • Further refinements
  • Afterword
  • Appendices
    • Appendix A - Sphinx conf.py file
    • Appendix B - custom css file
gdscript2rst
  • »
  • Appendices
  • Edit on GitHub

Appendices

  • Appendix A - Sphinx conf.py file
  • Appendix B - custom css file
Previous Next

© Copyright 2022, Douglas Webster. Revision 422a7e3f.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: latest
Versions
latest
Downloads
On Read the Docs
Project Home
Builds