diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 00000000..ee1f4055 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,21 @@ +version: 2 + +build: + image: latest + apt_packages: + - libpci-dev + +# As of June 2021, We need to set up a conda environment to install +# a sufficiently new Node.js: https://github.com/readthedocs/readthedocs.org/issues/8249 + +conda: + environment: .readthedocs_env.yml + +python: + version: 3.8 + install: + - method: pip + path: . + +sphinx: + configuration: docs/conf.py diff --git a/.readthedocs_env.yml b/.readthedocs_env.yml new file mode 100644 index 00000000..1414d206 --- /dev/null +++ b/.readthedocs_env.yml @@ -0,0 +1,33 @@ +name: pywwt_rtd +channels: + - conda-forge + +dependencies: + - astropy + - commonmark + - ipyevents + - ipython + - ipywidgets + - jupyterlab + - jupyterlab_widgets + - krb5 + - lxml + - matplotlib + - nodejs + - notebook + - numpydoc + - pip + - pyopengl + - pyqt + - pyqtwebengine + - python=3.8 + - qt + - qtpy + - recommonmark + - reproject + - scipy + - setuptools + - sphinx + - sphinx-automodapi + - sphinx_rtd_theme + - widgetsnbextension diff --git a/CHANGELOG.md b/CHANGELOG.md index 08f4e308..f08f0bdb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,9 @@ +# pypa:pywwt 0.11.3 (2021-06-09) + +- Another attempt to get ReadTheDocs to update the "stable" version of the + documentation. We need to automate updating of the `stable` Git branch. + + # pypa:pywwt 0.11.2 (2021-06-09) - Tidy up and modernize the installation instructions. Our ReadTheDocs defaults diff --git a/ci/azure-deployment.yml b/ci/azure-deployment.yml index 609c29aa..8a8274b8 100644 --- a/ci/azure-deployment.yml +++ b/ci/azure-deployment.yml @@ -31,9 +31,15 @@ jobs: setupCranko: true setupGit: true - bash: | - set -xeou pipefail + set -xeuo pipefail cranko release-workflow tag git push --tags origin release:release + + if cranko show if-released --exit-code pypa:pywwt ; then + # Special "stable" branch that ReadTheDocs watches. It doesn't seem + # possible to customize the name. + git push origin release:stable + fi displayName: Tag and push env: GITHUB_TOKEN: $(GITHUB_TOKEN) @@ -50,7 +56,7 @@ jobs: setupCranko: true setupGit: true - bash: | - set -xeou pipefail + set -xeuo pipefail cranko github create-releases displayName: Create GitHub releases env: @@ -99,7 +105,7 @@ jobs: - bash: cd frontend && npm run build displayName: NPM build - bash: | - set -xeou pipefail + set -xeuo pipefail cranko npm foreach-released npm publish displayName: Publish to NPM - bash: shred ~/.npmrc diff --git a/pywwt/_version.py b/pywwt/_version.py index 9fdadc1f..f74bce0c 100644 --- a/pywwt/_version.py +++ b/pywwt/_version.py @@ -1,4 +1,4 @@ -version_info = (0, 11, 2, 'final', 0) # cranko project-version tuple +version_info = (0, 11, 3, 'final', 0) # cranko project-version tuple _specifier_ = {'alpha': '.a', 'beta': '.b', 'candidate': '.rc', 'final': '', 'dev': '.dev'} diff --git a/readthedocs.yml b/readthedocs.yml deleted file mode 100644 index 70f6ac0b..00000000 --- a/readthedocs.yml +++ /dev/null @@ -1,10 +0,0 @@ -build: - image: latest - -python: - version: 3.8 - pip_install: true - extra_requirements: ['docs', 'qt'] - -# Don't build any extra formats -formats: []