Programmatically access markdown
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.2k
- Forks
- 146
- PR merge metrics
- No merged PRs in 30d
Description
I would like to access the markdown formatted documentation programmatically. I understand that I could provide my own .mako files overwriting "text.mako" for example, but I was wondering if there was a better way, that I didn't find in the documentation.
Additionally, is there a reason as to why there is a text and html attribute in the module class but no markdown?
Best,
Contributor guide
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
Review the module class and documentation generation path to see how the existing text and html attributes are exposed. Determine whether markdown access is already supported through the documented template mechanism or requires a new public interface. Done means the supported behavior and its documentation are clear, with tests or examples covering markdown access if it is added.
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
- Needs clarification
- Newbie friendliness
- 25/100