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

Improve readthedocs formatting #325

Open
jakebeal opened this issue Oct 7, 2021 · 7 comments
Open

Improve readthedocs formatting #325

jakebeal opened this issue Oct 7, 2021 · 7 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Milestone

Comments

@jakebeal
Copy link
Contributor

jakebeal commented Oct 7, 2021

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.

@jakebeal jakebeal added this to the 1.0 milestone Oct 7, 2021
@jakebeal jakebeal added documentation Improvements or additions to documentation good first issue Good for newcomers labels Feb 10, 2022
@ahmedtarek26
Copy link

ahmedtarek26 commented Feb 4, 2023

I read about readthedocs then looked at pySBOL3 and python docs
what I found is that the python API documentation has titles and subtitles and each subtitle has an attached link containing the details
could you tell me tips about the updates I can do with API reference at pySBOL3 doc?

@tcmitchell
Copy link
Collaborator

tcmitchell commented Feb 8, 2023

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?

@ahmedtarek26
Copy link

Yeah that's good, I'll start on the issue and tell you the updates
Thanks @tcmitchell

@sriramsowmithri9807
Copy link

@jakebeal can you mention code!!

@jakebeal
Copy link
Contributor Author

jakebeal commented Jan 7, 2025

@sriramsowmithri9807 I'm afraid that I'm not quite clear on what you are asking?

@sriramsowmithri9807
Copy link

@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.

@jakebeal
Copy link
Contributor Author

jakebeal commented Jan 8, 2025

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

4 participants