Skip to content

Commit

Permalink
Set up RLax sphinx documentation for readthedocs to build and serve d…
Browse files Browse the repository at this point in the history
…ocumentation from the public github.

PiperOrigin-RevId: 412441791
  • Loading branch information
katebaumli authored and RLaxDev committed Nov 26, 2021
1 parent c956c14 commit 2a41c5c
Show file tree
Hide file tree
Showing 9 changed files with 1,224 additions and 0 deletions.
17 changes: 17 additions & 0 deletions .readthedocs.yaml
@@ -0,0 +1,17 @@
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

version: 2

sphinx:
builder: html
configuration: docs/conf.py
fail_on_warning: false

python:
version: 3.7
install:
- requirements: requirements/requirements-docs.txt
- requirements: requirements/requirements.txt
- method: setuptools
path: .
1 change: 1 addition & 0 deletions docs/.gitignore
@@ -0,0 +1 @@
_build
19 changes: 19 additions & 0 deletions docs/Makefile
@@ -0,0 +1,19 @@
# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SOURCEDIR = .
BUILDDIR = _build

# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

0 comments on commit 2a41c5c

Please sign in to comment.