DOC: ReadTheDocs: disable LaTeX formats and cleanup version info (#184)

* RTD config: Switch off building `all` formats, since LaTeX builds are failing (#167) * Cleanup ESPEI development `|version|` information to remove the `.dirty` from the version since RTD dirties the version info
PhasesResearchLab · May 8, 2021 · 7684418 · 7684418
1 parent e4913e0
commit 7684418
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 2 deletions.
diff --git a/.gitignore b/.gitignore
@@ -12,4 +12,4 @@ docs/_build
 # Editors
 *.sublime-project
 *.sublime-workspace
-.vscode
+.vscode
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -3,4 +3,6 @@ version: 2
 conda:
   environment: environment-dev.yml
 
-formats: all
+# PDF/LaTeX currently broken
+# see: https://github.com/PhasesResearchLab/ESPEI/issues/167
+formats: []
diff --git a/docs/conf.py b/docs/conf.py
@@ -21,6 +21,9 @@
 import sys
 sys.path.insert(0, os.path.abspath('..'))  # For autodoc and version loading
 from espei import __version__ as espei_version
+# Cleanup ESPEI version, since RTD dirties the repository
+if espei_version.endswith('.dirty'):
+    espei_version = espei_version[:-6]
 
 # -- General configuration ------------------------------------------------