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

Bring in the Datasette documentation #8

Closed
simonw opened this issue Jul 12, 2020 · 6 comments
Closed

Bring in the Datasette documentation #8

simonw opened this issue Jul 12, 2020 · 6 comments

Comments

@simonw
Copy link
Owner

simonw commented Jul 12, 2020

This will be tricky. I'll probably need to build a custom template for Sphinx.

@simonw
Copy link
Owner Author

simonw commented Jul 12, 2020

https://github.com/sphinx-contrib/sphinxcontrib-versioning looks useful.

But.. it's broken with latest Sphinx. sphinx-contrib/sphinxcontrib-versioning#78 has a workaround.

pip install https://github.com/z00sts/sphinxcontrib-versioning/archive/sphinx1.7-import-error-workaround.zip gets the workaround.

@simonw
Copy link
Owner Author

simonw commented Jul 12, 2020

I think you run it like this:

sphinx-versioning build docs _built

docs here tells it that the documentation lives in the docs folder within the root.

@simonw
Copy link
Owner Author

simonw commented Jul 12, 2020

Getting this working is tricky. I'm inclined to keep stuff on readthedocs instead and point docs.datasette.io at it.

Still want a custom theme to add the site navigation though.

@simonw
Copy link
Owner Author

simonw commented Jul 12, 2020

Filed a feature request readthedocs/sphinx_rtd_theme#977

@simonw
Copy link
Owner Author

simonw commented Jul 12, 2020

OK I have a custom theme which can re-point the logo URL to another site now: https://github.com/simonw/sphinx_rtd_theme/archive/37773d730cfa6cb34a9cceb3332e648c079afe99.zip

@simonw
Copy link
Owner Author

simonw commented Jul 12, 2020

I'm sticking with the new themed https://datasette.readthedocs.io/en/latest/ with the logo.

@simonw simonw closed this as completed Jul 12, 2020
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

1 participant