ReadTheDocs Missing Capabilites
- Dominant language
- Python
- Stars
- 24
- Forks
- 25
- PR merge metrics
- No merged PRs in 30d
Description
Our readthedocs setup is missing a few things that we need to add at some point:
1. Search Feature not functional - user can `ctrl-f` on pages but can not use search bar due to `:noindex:` being applied in the `index.rst`. This was applied to resolve warnings that were blocking build
2. Missing Overview
3. Code Blocks are not showing as code block but instead like in line code
Contributor guide
Research direction
Start by reading index.rst and running the ReadTheDocs documentation build to reproduce the search, overview, and code-block problems. Check the generated documentation for each reported issue; done means the search bar works, an overview is present, and code blocks render as blocks without build-blocking warnings.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100