Investigate ReadTheDocs to ease documentation readability
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
- Issue type
- Feature
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- python
- Domain
- documentation
Research direction
No files or tests are named. Start by reviewing how the Sphinx-generated API documentation is currently published on GitHub Pages, then investigate the ReadTheDocs theme and platform, including versioning and hosting trade-offs; done means documenting the benefits, concerns, and a recommendation for approval.
Written by the indexing model from the issue text.
Description
Is there an existing issue for this?
- I have searched the existing issues.
Please describe the feature you have in mind and explain what the current shortcomings are?
This work needs to be approved first.
From a discussion with @dee-ynput and @mkolar it looks like readthedocs (theme and/or platform) might be beneficial for the automated API docs generated through Sphinx.
This could be investigated to assess the benefit/concerns.
How would you imagine the implementation of the feature?
No precise idea yet, it could be simply use the ReadTheDocs theme with sphinx or bringing more in order to get versioning feature automatically there for free.
We need to see if everything can remain on GitHub pages in order to not multiplying the host platforms tho..
Are there any labels you wish to add?
- I have added the relevant labels to the enhancement request.
Describe alternatives you've considered:
No response
Additional context:
No response
- Dominant language
- Python
- Stars
- 16
- Forks
- 15
- Avg merge
- 1d 9h
- Merged PRs (30d)
- 10
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from ynput/ayon-python-api
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
ynput/ayon-python-api#351 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 68/100
ynput/ayon-python-api#350 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
ynput/ayon-python-api#199 ·
-
ynput/ayon-python-api#198 · 1 assignee ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 50/100
ynput/ayon-python-api#182 ·
All issues in ynput/ayon-python-api
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100