Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Using theme with githubpages/readthedocs #40

Open
DerWeh opened this issue Aug 20, 2018 · 2 comments
Open

Using theme with githubpages/readthedocs #40

DerWeh opened this issue Aug 20, 2018 · 2 comments

Comments

@DerWeh
Copy link

DerWeh commented Aug 20, 2018

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
Copy link

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
Copy link

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants