search

GrahamDumpleton / wrapt

A Python module for decorators, wrappers and monkey patching.
BSD 2-Clause "Simplified" License
2.03k stars 231 forks source link

Documentation isn't building? #254

Closed hynek closed 9 months ago

hynek commented 10 months ago

Hi and congrats on 1.16! It looks like RTD isn't building your docs (anymore?), since the release notes are stuck at 1.15: https://wrapt.readthedocs.io/en/latest/changes.html

Less importantly, 50% of your README badges are broken (both on GitHub and PyPI): CleanShot 2023-11-10 at 08 13 05@2x

(I personally would replace the badge with something useful like a link to the docs)

GrahamDumpleton commented 10 months ago

My bad. I have to manually trigger ReadTheDocs to build. I don't know what happened to the auto trigger for build.

I have no idea why the badge for GitHub actions is showing failed even when builds complete. I was going to remove it but forgot again and only remembered after had done the release. :-(

Life is very hectic right now, so wrapt is definitely not getting the attention it should.

GrahamDumpleton commented 10 months ago

Ahh, crap. Have been totally forgetting that docs config has separate version string. In mod_wsgi I have it calculated from single file. So docs has been showing wrong version in title for a long time. :-(

hynek commented 10 months ago

Since you build on 3.11 anyway, may I recommend using importlib.metadata? https://github.com/hynek/structlog/blob/057fe3693b0b06e7f3105658851f30f0130b5f41/docs/conf.py#L52-L55

hynek commented 10 months ago

your docs are now built in the default theme – I assume that's not on purpose and caused by the READTHEDOCS env var shenanigans.

I would recommend to straight-out switch to Furo which is simple yet beautiful: https://www.structlog.org/en/stable/getting-started.html

(just depend on "furo" in your docs build env)

GrahamDumpleton commented 10 months ago

I think I managed to fix up ReadTheDocs, albeit still manually triggered for now. The GitHub actions badge as it appears on PyPi will be broken until do another release.

hynek commented 9 months ago

I guess this can be closed then!