CODEWITHSUNDEEP
python-sphinxgithub-pages
jsuereth
jsuereth

Reputation: 5624

How do I change `_target` output directory for HTML Builder in sphinx?

I'm trying to use Sphinx to build docuemntation to push to github pages. I'm using the default html builder to generate help documentation and pushing that into a gh-pages branch (see https://github.com/sbt/sbt-native-packager/tree/gh-pages).

It appears like the github pages integration doesn't like directories beginning with _, and makes the _static directory hidden. My site appears with no style (much like myself).

Is there any way to configure Sphinx to use static/ instead of _static/ in its generated pages? I tried html_static_path but no dice.

Thanks!

Upvotes: 7

Views: 2576

Answers (1)

mzjn
mzjn

Reputation: 51062

It is a known issue. See this Google Groups thread. The github-tools project has a workaround in sphinx.py.

See also https://stackoverflow.com/a/6398875/407651.

Upvotes: 5

Related Questions