Documentation and installation cleanup

dreamworksanimation · May 14, 2019 · 0004ca2 · 0004ca2
1 parent f25c5ba
commit 0004ca2
Show file tree

Hide file tree

Showing 32 changed files with 29 additions and 294 deletions.
diff --git a/.gitignore b/.gitignore
@@ -108,6 +108,7 @@ instance/
 
 # Sphinx documentation
 docs/_build/
+docs/api/
 
 # PyBuilder
 target/

diff --git a/README.md b/README.md
@@ -109,13 +109,11 @@ information on this requirement.
 3. Build a local copy
 ```
 python setup.py install --user
+pip install -r docs/requirements.txt
 ```
 4. Write code, following the [style guide](docs/contributing.md).
 5. Test it
-6. Update any manual documentation pages (like this one) and run sphinx-apidoc with the following command:
-```
-sphinx-apidoc -o ./docs/api/ -e -P -f ./usdmanager/
-```
+6. Update any manual documentation pages (like this one)
 7. Test that the documentation builds without errors with:
 ```
 sphinx-build -b html docs/ docs/_build

diff --git a/docs/INSTALL.md b/docs/INSTALL.md
diff --git a/docs/api/modules.rst b/docs/api/modules.rst
diff --git a/docs/api/usdmanager.constants.rst b/docs/api/usdmanager.constants.rst
diff --git a/docs/api/usdmanager.file_dialog.rst b/docs/api/usdmanager.file_dialog.rst
diff --git a/docs/api/usdmanager.file_status.rst b/docs/api/usdmanager.file_status.rst
diff --git a/docs/api/usdmanager.find_dialog.rst b/docs/api/usdmanager.find_dialog.rst
diff --git a/docs/api/usdmanager.highlighter.rst b/docs/api/usdmanager.highlighter.rst
diff --git a/docs/api/usdmanager.highlighters.lua.rst b/docs/api/usdmanager.highlighters.lua.rst
diff --git a/docs/api/usdmanager.highlighters.python.rst b/docs/api/usdmanager.highlighters.python.rst
diff --git a/docs/api/usdmanager.highlighters.rst b/docs/api/usdmanager.highlighters.rst
diff --git a/docs/api/usdmanager.highlighters.usd.rst b/docs/api/usdmanager.highlighters.usd.rst
diff --git a/docs/api/usdmanager.highlighters.xml.rst b/docs/api/usdmanager.highlighters.xml.rst
diff --git a/docs/api/usdmanager.images_rc.rst b/docs/api/usdmanager.images_rc.rst
diff --git a/docs/api/usdmanager.include_panel.rst b/docs/api/usdmanager.include_panel.rst
diff --git a/docs/api/usdmanager.linenumbers.rst b/docs/api/usdmanager.linenumbers.rst
diff --git a/docs/api/usdmanager.plugins.images_rc.rst b/docs/api/usdmanager.plugins.images_rc.rst
diff --git a/docs/api/usdmanager.plugins.rst b/docs/api/usdmanager.plugins.rst
diff --git a/docs/api/usdmanager.preferences_dialog.rst b/docs/api/usdmanager.preferences_dialog.rst
diff --git a/docs/api/usdmanager.rst b/docs/api/usdmanager.rst
diff --git a/docs/api/usdmanager.utils.rst b/docs/api/usdmanager.utils.rst
diff --git a/docs/api/usdmanager.version.rst b/docs/api/usdmanager.version.rst
diff --git a/docs/codingStyle.md b/docs/codingStyle.md
diff --git a/docs/conf.py b/docs/conf.py
@@ -32,6 +32,7 @@
 extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.viewcode',
+    'sphinxcontrib.apidoc',
 ]
 
 autodoc_mock_imports = [
@@ -68,6 +69,12 @@
 # The full version, including alpha/beta/rc tags.
 release = __version__
 
+apidoc_module_dir = '../usdmanager'
+apidoc_output_dir = 'api'
+apidoc_separate_modules = True
+apidoc_toc_file = False
+apidoc_extra_args = ['-P', '-f']
+
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 #language = None

diff --git a/docs/contributing.md b/docs/contributing.md
@@ -38,13 +38,11 @@ one. Each commit should pass tests without requiring further commits.
 3. Build a local copy
 ```
 python setup.py install --user
+pip install -r docs/requirements.txt
 ```
 4. Write code, following the [style guide](#style-guide).
 5. Test it
-6. Update any manual documentation pages (like this one) and run sphinx-apidoc with the following command:
-```
-sphinx-apidoc -o ./docs/api/ -e -P -f ./usdmanager/
-```
+6. Update any manual documentation pages (like this one)
 7. Test that the documentation builds without errors with:
 ```
 sphinx-build -b html docs/ docs/_build

diff --git a/docs/icon.png b/docs/icon.png
diff --git a/docs/logo.png b/docs/logo.png
diff --git a/docs/logo_512.png b/docs/logo_512.png
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -0,0 +1,3 @@
+recommonmark>=0.5.0
+Sphinx>=1.8.5
+sphinxcontrib-apidoc>=0.3.0
diff --git a/readthedocs.yaml b/readthedocs.yaml
@@ -0,0 +1,14 @@
+# .readthedocs.yml
+# Use of v1 over v2 is intentional for maximum rtd compatibility
+
+formats: []  # Don't build htmlzip, pdf or epub
+
+build:
+  image: latest
+
+requirements_file: docs/requirements.txt
+
+python:
+  version: 2.7
+  setup_py_install: true
+  pip_install: false
diff --git a/setup.py b/setup.py
@@ -68,8 +68,6 @@
     ],
     setup_requires=[
         "setuptools>=2.2",
-        "Sphinx>=1.8.5",
-        "recommonmark>=0.5.0",
     ],
     tests_require=[],
     dependency_links=[],