From 8163c3d7c48d244c168f89386aeefae7d9df2c86 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dieter=20Werthm=C3=BCller?= Date: Thu, 22 Apr 2021 08:06:52 +0200 Subject: [PATCH] Fix doc-related things (#51) - Fix version number of documentation - Add `-b linkcheck` to `make html` - Expand the "history" within the changelog - Add links to Swung and the Swung-Slack --- .github/workflows/docs.yml | 26 ++++++++++++++++++++++---- CHANGELOG.rst | 21 ++++++++++++++++++--- docs/source/conf.py | 4 ++++ 3 files changed, 44 insertions(+), 7 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 065a556c..b830652e 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -2,7 +2,7 @@ name: docs # Controls when the action will run. on: - # Triggers the workflow on push or pull request events but only for the master branch + # Triggers the workflow on push or pull request events but only for main push: branches: - main @@ -16,6 +16,8 @@ on: jobs: docs: + name: Deploy docs + runs-on: ubuntu-latest env: @@ -25,7 +27,23 @@ jobs: SHELLOPTS: 'errexit:pipefail' steps: - - uses: actions/checkout@v2 + # Checks-out your repository under $GITHUB_WORKSPACE + - name: Checkout + uses: actions/checkout@v2 + with: + # Need to fetch more than the last commit so that setuptools_scm can + # create the correct version string. If the number of commits since + # the last release is greater than this, the version will still be + # wrong. Increase if necessary. + fetch-depth: 100 + # The GitHub token is preserved by default but this job doesn't need + # to be able to push to GitHub. + persist-credentials: false + + # Need the tags so that setuptools_scm can form a valid version number + - name: Fetch git tags + run: git fetch origin 'refs/tags/*:refs/tags/*' + - name: Setup Headless Display run: | sudo apt-get install libgl1-mesa-glx @@ -44,9 +62,9 @@ jobs: pip install -r requirements_dev.txt pip install -e . - - name: Generate Sphinx Docs + - name: Generate Docs & Check Links working-directory: docs/ - run: make html + run: make html -b linkcheck - name: Publish generated content to GitHub Pages uses: tsunematsu21/actions-publish-gh-pages@v1.0.1 diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 9be2ee60..198afee5 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -2,25 +2,40 @@ Changelog ######### +v0.x-series +=========== + v0.2.3 ------ First automatic deploy to PyPI and conda-forge. + +History +======= + + April 2021 ---------- -Transform 2021; geo-stack packages start to support subsurface. +**Transform2021:** `#t21-hack-subsurface` builds on the work done by @Leguark +during the time since Transform2020. First geo-stack packages start to support +subsurface: GemPy, pyGIMLi, segysak, verde (Fatiando), discretize (SimPEG), +PyVista, welly, striplog. June 2020 --------- -Transform2020; reviving it. +**Transform2020:** `#t20-hack-gostin` revives the idea with contributions from +many people of the SWUNG community, representing also many geo-stack +communities (GemPy, PyVista, Fatiando, SimPEG, pyGIMLi, map2loop, OMF, geoh5py, +and more). May 2019 -------- -Transform2019; and idea is born. +**Transform2019:** An idea is born at The Château in France (@kwinkunks, +@JesperDramsch, @alex-schaaf). diff --git a/docs/source/conf.py b/docs/source/conf.py index b56e8a7b..73c93813 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -138,6 +138,10 @@ html_context = { 'menu_links_name': 'Links', 'menu_links': [ + (' SWUNG', + 'https://softwareunderground.org'), + (' Slack', + 'https://swu.ng/slack'), (' Source Code', 'https://github.com/softwareunderground/subsurface'), ],