Fix Read The Docs - Githubissues

pystorm / streamparse

Run Python in Apache Storm topologies. Pythonic API, CLI tooling, and a topology DSL.

http://streamparse.readthedocs.io/

Apache License 2.0

1.5k stars 218 forks source link

Fix Read The Docs #506

Closed kbourgoin closed 2 months ago

kbourgoin commented 2 months ago

...does what it says on the tin.

Fixes RTD builds
Renames the main testing workflow action to "Tests"
Adds tests and docs build badges to the README
Updates the release doc file to be reST and makes the formatting/language similar to other docs in the library

Fixes #456

kbourgoin commented 2 months ago

Hey @thornycrackers, @rachelannelise, or @lmontopo. I see you on #505 pretty recently. Mind giving this a quick gander? I fixed it to read the docs works again, as do the badges on the README.

I reformatted the recent entry a bit as well so that it builds correctly.

thornycrackers commented 2 months ago

I ran a build with PYTHONPATH=$(pwd) sphinx-build -M html ./doc ./dist and everything seemed out build correctly with no warnings so :+1: