django-sharding icon indicating copy to clipboard operation
django-sharding copied to clipboard

Docs broken

Open M1ha-Shvn opened this issue 4 years ago • 5 comments

Hi. Docs link from README (https://www.josephkahn.io/django-sharding/) leads to 404 page.

M1ha-Shvn avatar Jul 27 '20 13:07 M1ha-Shvn

Did you figure out where the docs are. This is really painful not gettings docs.

abhiyan52 avatar Sep 22 '20 04:09 abhiyan52

I suspect it was just a version of https://github.com/JBKahn/django-sharding/tree/master/docs?

mwarkentin avatar Sep 22 '20 12:09 mwarkentin

It's probably more like being able to see a table of contents or page through each slide rather than referencing a single table of contents. Can forks make a RTD? I could perhaps host the docs.

Andrew-Chen-Wang avatar Sep 22 '20 14:09 Andrew-Chen-Wang

@Andrew-Chen-Wang Looks like it, I forked and was able to enable Github pages on the docs folder: https://mwarkentin.github.io/django-sharding/

mwarkentin avatar Sep 22 '20 19:09 mwarkentin

It might be helpful to just set up sphinx in a fork and try that with read the docs website. That way, it's easier to navigate.

Andrew-Chen-Wang avatar Sep 22 '20 21:09 Andrew-Chen-Wang