Kevin Li bb2c26cb94 fix(docs): pin Sphinx version to 3.x to generate CSS
Custom CSS seems to [have broken in Sphinx 4](https://github.com/sphinx-doc/sphinx/issues/2442).
Guessing readthedocs.io or their package repository upgraded the default
version of Sphinx to 4 and that caused our builds to start breaking.

They [recommend pinning dependencies](https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html#pinning-dependencies), let's do that here for Sphinx!
2021-09-15 18:18:44 -07:00
..
2020-11-28 11:21:35 -08:00
2021-02-08 18:32:21 -08:00
2020-12-18 11:14:49 -08:00
2020-12-17 10:24:16 -08:00
2020-10-27 16:31:15 -07:00

Dependencies

    pip3 install sphinx recommonmark sphinx-rtd-theme

Syntax

Documentation can be written in Markdown (.md) or Restructured Text (.rst).

Build and Test

cd docs
make html
open _build/html/index.html

Tips

  • Generate RST tables here.
  • Set your editor's wordwrap to 98 characters.