guzzle / guzzle_sphinx_theme

Sphinx theme used by Guzzle
MIT License
169 stars 60 forks source link

Using theme with githubpages/readthedocs #40

Open DerWeh opened 5 years ago

DerWeh commented 5 years ago

I can only get the theme to work locally. If I use make html it works properly, using automated tools like githubpages or readthedocs however, the documentation is broken.

How do I properly use it? I don't want an unnecessary dependency in my python project, thus it is not included in requirements.txt or setup.py. Instead, I just put a zip file in docs/source which works perfectly local, but not using a service. What is a proper way use this theme?

mapattacker commented 4 years ago

for git pages, u have to make html and upload only the html folder contents to either master or docs folder. I don't think u can use this in readthedocs, it was mentioned by the creator that u might run into issues, which I had too.

venaturum commented 3 years ago

I use guzzle_sphinx_theme with readthedocs no problem https://railing.readthedocs.io/en/latest/