jazzband / help

Use this repo to get help from the roadies
https://jazzband.co/roadies
27 stars 7 forks source link

django-pipeline's documentation doesn't update after releases #353

Open peymanslh opened 10 months ago

peymanslh commented 10 months ago

Recently we had two releases for django-pileline but the documentation was not updated. Its last build in Read-The-Docs failed more than a year ago. https://readthedocs.org/projects/django-pipeline/builds/

hugovk commented 10 months ago

The first thing to do is create a Read the Docs config file, it's now required:

https://blog.readthedocs.com/migrate-configuration-v2/

See some other Jazzband projects and:

https://docs.readthedocs.io/en/stable/config-file/v2.html

peymanslh commented 10 months ago

Thanks @hugovk

blaisep commented 5 months ago

@peymanslh

try creating this .readthedocs.yaml, then lmk if we can close this ticket and send me a url to the recent docs please.

# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

version: 2

build:
  os: ubuntu-22.04
  tools:
    python: "3.10"

sphinx:
  configuration: docs/conf.py

python:
  install:
  - requirements: requirements.txt
  - method: pip
    path: .

you may have to adjust paths, but I think I got it right for your project.

blaisep commented 5 months ago

@jezdez , I suppose the way to prevent this would be to add a check for .readthdocs.yaml in https://github.com/jazzband/.github/blob/main/.pullapprove.yml ? (rhetorical, no need to answer here)

peymanslh commented 3 months ago

I've added the .readthedocs.yaml file https://github.com/jazzband/django-pipeline/blob/master/.readthedocs.yaml Is there anything else that I need to do?

jezdez commented 2 months ago

I'm afraid the readthedocs project for django-pipeline was never transferred to Jazzband, so I can't do anything about it. It's owned by https://readthedocs.org/profiles/tim/.

peymanslh commented 2 months ago

@cyberdelia Could you help with transferring the ReadTheDocs ownership of django-pipeline to Jazzband?

cyberdelia commented 2 months ago

@peymanslh Just need an account name or email to add as a maintainer there.

jezdez commented 2 months ago

@cyberdelia jazzband-bot (profile) would be best

cyberdelia commented 2 months ago

@jezdez Invitation is pending!

peymanslh commented 20 hours ago

@jezdez Could you please provide us with an update on this issue?

cyberdelia commented 19 hours ago

The jazzband-bot is now a maintainer on read the docs.

peymanslh commented 6 hours ago

We have a release for next week, and I’ll close this issue if it’s resolved by then. Thanks for everyone's help