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

get API docs hosted #128

Closed
edaniszewski opened this issue Apr 6, 2018 · 0 comments · Fixed by #132
Closed

get API docs hosted #128

edaniszewski opened this issue Apr 6, 2018 · 0 comments · Fixed by #132

Comments

@edaniszewski
Copy link
Contributor

The user guide is hosted on readthedocs. The API docs were written for Slate because the layout is nice and lets us specify example code for multiple languages alongside the actual reference.

The API docs aren't hosted right now because readthedocs and github pages (how the API docs were originally intended to be hosted) are setup the same way, so they conflict with one another.

There are a few options on how to resolve this:

  • link in the API doc HTML into readthedocs (I briefly tried this, but its surprising not easy, if even possible)
  • do some funky organizing in the docs/ directory to allow github pages and readthedocs to work (not sure if this is possible, but I think it hypothetically should be)
  • host the API docs somewhere else
  • migrate API docs from Slate to readthedocs. I'm not particularly a fan of this one because I don't think the API documentation renders particularly well in rtd.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant