You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
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:
docs/
directory to allow github pages and readthedocs to work (not sure if this is possible, but I think it hypothetically should be)The text was updated successfully, but these errors were encountered: