Browse Source

Add publish to github pages configuration to make it easy to preview changes.

Ionel Cristian Mărieș 4 years ago
parent
commit
50bd06442e
6 changed files with 27 additions and 37 deletions
  1. 6 0
      .travis.yml
  2. 1 1
      MANIFEST.in
  3. BIN
      publish-key.enc
  4. 9 6
      tests/conf.py
  5. 0 11
      tests/spelling_wordlist.txt
  6. 11 19
      tox.ini

+ 6 - 0
.travis.yml

@@ -17,6 +17,12 @@ env:
     - TOXENV=pypy
     - TOXENV=pypy-nocover
 before_install:
+  - openssl aes-256-cbc -K $encrypted_87d9ccdaebfd_key -iv $encrypted_87d9ccdaebfd_iv -in publish-key.enc -out ~/.ssh/publish-key -d
+  - chmod u=rw,og= ~/.ssh/publish-key
+  - echo "Host github.com" >> ~/.ssh/config
+  - echo "  IdentityFile ~/.ssh/publish-key" >> ~/.ssh/config
+  - git --version
+  - git remote set-url origin git@github.com:ionelmc/sphinx-py3doc-enhanced-theme.git
   - python --version
   - virtualenv --version
   - pip --version

+ 1 - 1
MANIFEST.in

@@ -17,5 +17,5 @@ include LICENSE
 include README.rst
 
 include tox.ini .travis.yml appveyor.yml
-
+exclude publish-key.enc
 global-exclude *.py[cod] __pycache__ *.so

BIN
publish-key.enc


+ 9 - 6
tests/conf.py

@@ -29,13 +29,16 @@ html_theme = "sphinx_py3doc_enhanced_theme"
 html_theme_path = [sphinx_py3doc_enhanced_theme.get_html_theme_path()]
 html_theme_options = {
     'githuburl': 'https://github.com/ionelmc/sphinx-py3doc-enhanced-theme/',
-    'bodyfont': '"Lucida Grande",Arial,sans-serif',
-    'headfont': '"Lucida Grande",Arial,sans-serif',
-    'codefont': 'monospace,sans-serif',
-    'linkcolor': '#0072AA',
-    'visitedlinkcolor': '#6363bb',
-    'extrastyling': False,
 }
+if os.environ['EXTRASTYLING'] == 'false':
+    html_theme_options.update({
+        'bodyfont': '"Lucida Grande",Arial,sans-serif',
+        'headfont': '"Lucida Grande",Arial,sans-serif',
+        'codefont': 'monospace,sans-serif',
+        'linkcolor': '#0072AA',
+        'visitedlinkcolor': '#6363bb',
+        'extrastyling': False,
+    })
 pygments_style = 'friendly'
 templates_path = ['.']
 html_use_smartypants = True

+ 0 - 11
tests/spelling_wordlist.txt

@@ -1,11 +0,0 @@
-builtin
-builtins
-classmethod
-staticmethod
-classmethods
-staticmethods
-args
-kwargs
-callstack
-Changelog
-Indices

+ 11 - 19
tox.ini

@@ -3,34 +3,26 @@
 [tox]
 envlist =
     check,
-    docs-{2.7,3.4}
+    docs-{default,bare}
 
 [testenv]
-basepython =
-    {spell,2.7}: {env:TOXPYTHON:python2.7}
-    {check,3.4}: {env:TOXPYTHON:python3.4}
+basepython = {env:TOXPYTHON:python3.4}
+envdir = {toxinidir}/.tox/docs
 setenv =
-    PYTHONPATH={toxinidir}/tests
-    PYTHONUNBUFFERED=yes
+    normal: EXTRASTYLING=true
+    bare: EXTRASTYLING=false
 passenv =
     *
 deps =
     sphinx
+    ghp-import2
 commands =
-    2.7: sphinx-build {posargs:-E} -b html tests dist/docs-2.7
-    3.4: sphinx-build {posargs:-E} -b html tests dist/docs-3.4
-usedevelop = true
+    python -c 'import shutil; shutil.rmtree("dist", True)'
+    normal: sphinx-build {posargs:-E} -b html tests dist/normal
+    bare: sphinx-build {posargs:-E} -b html tests dist/bare
+    ghp-import -n -p -m "Update gh-pages." dist
 
-[testenv:spell]
-setenv =
-    SPELLCHECK=1
-commands =
-    sphinx-build -b spelling docs dist/docs
 usedevelop = true
-deps =
-    -r{toxinidir}/docs/requirements.txt
-    sphinxcontrib-spelling
-    pyenchant
 
 [testenv:check]
 basepython = python3.4
@@ -44,4 +36,4 @@ skip_install = true
 commands =
     python setup.py check --strict --metadata --restructuredtext
     check-manifest {toxinidir}
-    flake8 src
+    flake8 src