Add support for Sphinx directives
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 224
- Forks
- 36
- PR merge metrics
- No merged PRs in 30d
Description
I have sphinx-documentation for project which contains rst file which has links to all other document. This is achieved by "toctree" directive of sphinx.
If you run restview with such rst file which contains toctree directive, restview fails to render document.
It would be good to add support for toctree directive which will make all other rst document as hyperlinks.
I am using
Fedora 22
restview 2.4.0
Python 2.7
I would love to contribute on this feature.
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.
Research direction
Reproduce the failure by running restview on an RST file containing a Sphinx toctree directive, using the issue's described setup as a reference. Trace how the directive is handled and verify that the referenced documents render as hyperlinks without causing restview to fail.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100