Skip to content
This repository has been archived by the owner on Feb 14, 2021. It is now read-only.

simdsoft/xsdocs

Repository files navigation

xsdocs-936

Documentation Status The Simplified Chinese Documentation repo of x-studio IDE, for english please see: xsdocs-437

pitfall: Don't add Documentation Status to index.rst, otherwise, build pdf will be failed.

Sphinx references

https://github.com/godotengine/godot-docs
https://github.com/scrapinghub/splash

Install sphinx reST docs preview env

  1. Install Python-3.7.x+
  2. Install Python Extensions for vscode rst preview: sphinx, sphinx_rtd_theme, sphinx_tabs: pip install sphinx sphinx_rtd_theme sphinx_tabs sphinxcontrib-svg2pdfconverter
  3. Install Microsoft VS Code
  4. Install Microsoft VS Code extension: reStructedText, just search rst