sphinx-doc / sphinx-autobuild

Watch a Sphinx directory and rebuild the documentation when a change is detected. Also includes a hot-reload web server.
MIT License
523 stars 75 forks source link

Maintainance status -- new release soon! #81

Closed pradyunsg closed 3 years ago

pradyunsg commented 3 years ago

Hey @GaretJax!

I see that this package hasn't been updated in a while. Is this still actively maintained? If not, would you be OK with transferring maintainership of this project to someone else (either an individual - I am happy to volunteer for that - or an org like jazzband or executablebooks)?

chrisjsewell commented 3 years ago

Yes we at https://github.com/executablebooks would most probably be happy to take it on

chrisjsewell commented 3 years ago

And obviously still set you as an one of the owners

GaretJax commented 3 years ago

Hi @pradyunsg, thanks for the offer. I think there have been talks between @evildmp and jazzband in the past about this, but I don't know what the status is there; that would be my preferred solution.

I didn't know about executablebooks @chrisjsewell, but it looks like you do a lot of sphinx indeed, so it may be even a better home.

chrisjsewell commented 3 years ago

oh yes a lot lol! and @pradyunsg has been helping us out on the web design side of things which is obviously where this package comes in very handy thanks. We're just integrating into our development process (see https://github.com/executablebooks/sphinx-book-theme/pull/172) so would certainly like to keep it active.

But yeh naturally its entirely up to you, but just let us know if you do want to and I wouldn't foresee any objections 😄

GaretJax commented 3 years ago

Could we start maybe by adding @pradyunsg (and you @chrisjsewell, don't know how you're organized) to this repo and see how things go? If all goes well, I'm then happy to transfer it to another org.

chrisjsewell commented 3 years ago

yep no problem, sounds good to me 👍

GaretJax commented 3 years ago

Who shall I add?

chrisjsewell commented 3 years ago

@pradyunsg you opened the issue so should have first refusal 😊

pradyunsg commented 3 years ago

Sounds great to me!

Please feel free to add me (and @chrisjsewell, if they say they're OK with it) here and we'll take it from there. :)

GaretJax commented 3 years ago

@pradyunsg you have access as a collaborator to the repo.

pradyunsg commented 3 years ago

Oh awesome! Thank you! ^.^

My next instinctive question is, PyPI access. Would you be willing to give me publish access on PyPI as well? (same username there, https://pypi.org/user/pradyunsg/)

chrisjsewell commented 3 years ago

Well we could just move the testing/deployment to GitHub actions. Then it just requires an API secret being set on the repository 😉

(like https://github.com/executablebooks/MyST-Parser/blob/master/.github/workflows/tests.yml)

pradyunsg commented 3 years ago

We certainly can/should do that, but my concern stems more from a bus factor perspective for this project. :)

GaretJax commented 3 years ago

I'll give you access in due course @pradyunsg ;-)

pradyunsg commented 3 years ago

Sounds fair to me! ^>^

choldgraf commented 3 years ago

Damn we will have to refactor our plans to install crypto miners in everybody's Sphinx builds 😅

but seriously - thanks @GaretJax for inviting collaboration on this repo!

pradyunsg commented 3 years ago

LOL

I'm pretty sure we have access to better "targets" if we really wanted to spread crypto miners around. 😂

GaretJax commented 3 years ago

I knew it!

pradyunsg commented 3 years ago

For anyone wondering what's up, the PRs and issues here got a round of triage and there's #83. I guess I'll go clicky on the merge button sooner-than-later on that one -- but feel free to holler if you'd prefer I slow down.

Also, I find making follow up PRs is usually pretty cheap. :)

chrisjsewell commented 3 years ago

Yep looking better 👍 re #85, why not just move to Github Actions?

chrisjsewell commented 3 years ago

Also, my 10 cents, I'd move to click for the CLI

pradyunsg commented 3 years ago

why not just move to Github Actions?

Coz I don't have the permissions on this repo to turn off Travis CI. 🙃

I'd move to click for the CLI

Yup. Was thinking about that too -- but I think there's a few more "pressing" issues at hand, like trimming dependencies and reducing "failure rate". :)

chrisjsewell commented 3 years ago

Coz I don't have the permissions on this repo to turn off Travis CI

You shouldn't need it, just delete the web hook in the repo settings? (oh or maybe you can't if you are only a collaborator)

but I think there's a few more "pressing" issues at hand, like trimming dependencies and reducing "failure rate"

Nah, no one cares about those 😆

chrisjsewell commented 3 years ago

Oh and I also expect you to use myst-parser and sphinx-book-theme for the RTD docs 😉

pradyunsg commented 3 years ago

You shouldn't need it, just delete the web hook in the repo settings? (oh or maybe you can't if you are only a collaborator)

That. :P

pradyunsg commented 3 years ago

Ahoy @GaretJax! I think we're almost ready for a release.

pradyunsg commented 3 years ago

93 and #94 await @GaretJax's OK (and PyPI access).

pradyunsg commented 3 years ago

Oh and I also expect you to use myst-parser and sphinx-book-theme for the RTD docs 😉

I don't think this project needs RTD docs. Checkout the README! :)

GaretJax commented 3 years ago

@pradyunsg you have been granted access to PyPI and I approved the two PRs. I tried to transfer the project but I don't have the rights to create public repos on the executablebooks organisation. It also does not seem possible to grant you more privileges as what you already have here. I also tried to transfer the ownership to yourself (so that you can transfer it to the org), but you already have a fork of the repo.

chrisjsewell commented 3 years ago

@GaretJax I've just invited you as a member of executablebooks 😄

GaretJax commented 3 years ago

Transferred!

chrisjsewell commented 3 years ago

🎉 thanks, @pradyunsg we can start crypto mining 😂

chrisjsewell commented 3 years ago

@pradyunsg I just gave you maintainer status

pradyunsg commented 3 years ago

@chrisjsewell Could you make me an admin? I can't see webhooks and don't have the ability to manage protected branches.

pradyunsg commented 3 years ago

@pradyunsg you have been granted access to PyPI and I approved the two PRs.

Awesome! Thank you @GaretJax! ^>^

pradyunsg commented 3 years ago

Note to self: make a release on 1st. :)

pradyunsg commented 3 years ago

sphinx-autobuild 2020.9.1 is out! We're golden. Now, let's see if people report breakages, or if anyone complains. :)

pradyunsg commented 3 years ago

Thanks everyone here! Definitely wouldn't have happened without y'all. ^>^

GaretJax commented 3 years ago

Thank you @pradyunsg for resurrecting the project! :heart: