-
Notifications
You must be signed in to change notification settings - Fork 174
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
[Docs] Move API docs into the API module #6151
Conversation
This moves the documentation for the REST API into the API module. It existed under docs previously because it was written before the module existed. Symlinks are used to keep the documentation rendered under ReadTheDocs since it's useful to include a reference for people reading the LORIS documentation.
Transitory failure? We should look out for this during testing and maybe disable this test if it's not working |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks fine. I'm in favour of merging it. We can see whether ReadTheDocs will do symlinks and fix if not
It should definitely work with the symlinks. The question is if it would work without them.. |
This moves the documentation for the REST API into the API module. It existed under docs previously because it was written before the module existed. Symlinks are used to keep the documentation rendered under ReadTheDocs since it's useful to include a reference for people reading the LORIS documentation.
This moves the documentation for the REST API into the API module. It existed under docs previously because it was written before the module existed. Symlinks are used to keep the documentation rendered under ReadTheDocs since it's useful to include a reference for people reading the LORIS documentation.
This moves the documentation for the REST API into the API module. It existed under docs previously because it was written before the module existed. Symlinks are used to keep the documentation rendered under ReadTheDocs since it's useful to include a reference for people reading the LORIS documentation.
followup note - the wiki main link broke. samir emailed me for an urgent fix on this today. |
This moves the documentation for the REST API into the API module. It existed under docs previously because it was written before the module existed. Symlinks are used to keep the documentation rendered under ReadTheDocs since it's useful to include a reference for people reading the LORIS documentation.
This moves the documentation for the REST API into the
API module. It existed under docs previously because
it was written before the module existed.
Symlinks are used to keep the documentation rendered
under ReadTheDocs since it's useful to include a reference
for users looking to use the LORIS API.
If we're lucky, I didn't break anything.