Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Autodoc fixes #6

Merged
merged 2 commits into from
Aug 11, 2023
Merged

Autodoc fixes #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d0dd06c
Autodoc on non-beta tagging. Remove some empty module doc. This repo …
netsettler Aug 11, 2023
218aaec
Don't wait for manual confirmation on autodoc. Add changelog. Bump pa…
netsettler Aug 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions .github/workflows/main-deploy-docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,14 @@

name: deploy-docs

# Controls when the action will run.
# Controls when the action will run.
on:
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# All non-beta tag pushes.
push:
tags:
- 'v*'
except:
- 'v*b*'
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we really not want to push betas automatically?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Practically, no matter what we might wish, the way this is written it's going to always autodoc master, so a tag on a PR on a branch would not end up having the doc from that branch processed.

But also I think if someone wants beta doc, they can ask for it manually. We rev betas a lot more often than we change doc and I fear it'd be clutter. Worst case, beta doc might appear before it was usable and really confuse people.


# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
Expand All @@ -22,4 +26,4 @@ jobs:
- name: Docs
env:
DOCS_TOKEN: ${{ secrets.DOCS_TOKEN }}
run: curl -X POST -d "branches=master" -d "token=$DOCS_TOKEN" https://readthedocs.org/api/v2/webhook/submitr/246175/
run: curl -X POST -d "ref=master" -d "token=$DOCS_TOKEN" https://readthedocs.org/api/v2/webhook/submitr/246175/
11 changes: 11 additions & 0 deletions CHANGELOG.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,17 @@ submitr
Change Log
----------

0.3.1
=====

* Auto-submit to readthedocs on any non-beta version tag push (v* except v*b*).
* Fix a bug in readthedocs submission where we were using branches=master and getting an error saying
``{"detail":"Parameter \"ref\" is required"}``. ChatGPT thinks this is because we wanted a curl
parameter of ``-d "ref=master"`` rather than ``-d "branches=master"`` like we had.
* Remove spurious "Module Contents" headings in three places.
We do not put code in ``__init__.py`` so these sections would always be empty (and confusing).


0.3.0
=====

Expand Down
8 changes: 0 additions & 8 deletions docs/source/submitr.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,11 +44,3 @@ submitr.utils module
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: submitr
:members:
:undoc-members:
:show-inheritance:
8 changes: 0 additions & 8 deletions docs/source/submitr.scripts.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,3 @@ submitr.scripts.upload\_item\_data module
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: submitr.scripts
:members:
:undoc-members:
:show-inheritance:
8 changes: 0 additions & 8 deletions docs/source/submitr.tests.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,11 +67,3 @@ submitr.tests.test\_utils module
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: submitr.tests
:members:
:undoc-members:
:show-inheritance:
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "submitr"
version = "0.3.0"
version = "0.3.1"
description = "Support for uploading file submissions to SMAHT."
# TODO: Update this email address when a more specific one is available for SMaHT.
authors = ["4DN-DCIC Team <[email protected]>"]
Expand Down