-
Notifications
You must be signed in to change notification settings - Fork 16
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
Improve readthedocs formatting #325
Comments
I read about readthedocs then looked at pySBOL3 and python docs |
The goal for this issue is to have the pySBOL3 API documentation look more like the Python documentation (https://docs.python.org/3/library/random.html). Specifically, the pySBOL3 API pages under https://pysbol3.readthedocs.io/en/stable/autoapi/index.html, like https://pysbol3.readthedocs.io/en/stable/autoapi/sbol3/attachment/index.html Is that enough to get started? |
Yeah that's good, I'll start on the issue and tell you the updates |
@jakebeal can you mention code!! |
@sriramsowmithri9807 I'm afraid that I'm not quite clear on what you are asking? |
@jakebeal, could you clarify the exact error you’re encountering in the API section? Here's the [documentation for the API Reference](https://pysbol3.readthedocs.io/en/stable/autoapi/index.html) for your reference. |
There's no error - we're just thinking that it could be prettier than it is, per the comment from @tcmitchell above, and not sure whether readthedocs can be configured to do so. |
Something seems to be going wrong in our readthedocs API generation. We'd like it to look more like the python API documentation, and it's just not as pretty as we'd like it to be yet.
The text was updated successfully, but these errors were encountered: