Configure ReadTheDocs

bats-core · Nov 23, 2020 · 1f312d5 · 1f312d5
1 parent d4fbad3
commit 1f312d5
Show file tree

Hide file tree

Showing 8 changed files with 16 additions and 37 deletions.
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -0,0 +1,9 @@
+version: 2
+
+sphinx:
+  configuration: docs/source/conf.py
+
+python:
+  version: 3.7
+  install:
+    - requirements: docs/source/requirements.txt
diff --git a/.travis.yml b/.travis.yml
@@ -2,7 +2,6 @@ language: bash
 
 stages:
   - test
-  - deploy
 
 os:
 - linux
@@ -21,23 +20,6 @@ matrix:
   include:
     - os: osx
       env: ''
-    - stage: deploy  
-      env: ''
-      before_script:
-      - sudo apt-get install python3-pip
-      - sudo pip3 install sphinx-multiversion sphinxcontrib-programoutput recommonmark
-      script:
-      - | 
-        mkdir html
-        sphinx-multiversion docs/source html
-      before_deploy:
-        - touch html/.nojekyll
-      deploy:
-      - provider: pages
-        skip_cleanup: true
-        github_token: $GITHUB_TOKEN
-        keep_history: false
-        local_dir: html
 
 services:
   - docker

diff --git a/docs/source/_static/.gitkeep b/docs/source/_static/.gitkeep
diff --git a/docs/source/_templates/.gitkeep b/docs/source/_templates/.gitkeep
diff --git a/docs/source/_templates/versioning.html b/docs/source/_templates/versioning.html
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -32,8 +32,7 @@
 # ones.
 extensions = [
     'recommonmark',
-    'sphinxcontrib.programoutput',
-    'sphinx_multiversion'
+    'sphinxcontrib.programoutput'
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -44,8 +43,7 @@
         'navigation.html',
         'relations.html',
         'searchbox.html',
-        'donate.html',
-        'versioning.html'] }
+        'donate.html'] }
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -58,7 +56,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+#html_theme = 'alabaster'
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,11 +1,8 @@
-.. bats-core documentation master file, created by
-   sphinx-quickstart on Wed Sep  2 23:33:57 2020.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
 Welcome to bats-core's documentation!
 =====================================
 
+Versions before v1.2.1 are documented over `there <https://github.com/bats-core/bats-core/blob/master/docs/versions.md>`_.
+
 .. toctree::
    :maxdepth: 2
    :caption: Contents:

diff --git a/docs/source/requirements.txt b/docs/source/requirements.txt
@@ -0,0 +1,2 @@
+sphinxcontrib-programoutput
+recommonmark