pdoc3 / pdoc3/pdoc

Add GitHub Flavor Markdown support

Open
#433 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
1.2k
Forks
146
PR merge metrics
No merged PRs in 30d

Description

Expected Behavior

I am currently including my readme markdown file in the documentation to make sure all information is up to date whenever it is changed in the readme.
Specifically, it is done in the init.py via the docstring and used to generate HTML
"""
.. include:: ../../README.md
"""

Actual Behavior

The "include" does not display certain things properly:

  1. Lists do not seem to work, which is weird
  2. JPG images, although it does seem to plot SVG images.
  3. Certain features like latex \begin{align} do not work and cause linebreaks to be removed
  4. Latex in Tables doesn't seem to work

Quick links to the example at hand:
documentation: https://the-rccg.github.io/hw2d/index.html
github readme: https://github.com/the-rccg/hw2d

Additional info

Specification of GitHub Flavor Markdown: https://github.github.com/gfm/
Previous Maths display issues: https://github.com/pdoc3/pdoc/issues/70
Seems to also be related to this issue: https://github.com/pdoc3/pdoc/issues/269
However, some of the problems at least seem to be specific to the include as it does not render Lists or images that should be standard markdown behavior? I'm not too familiar with the different flavors and only now getting started looking into this.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by inspecting the README.md inclusion in the init.py docstring and reproducing the generated HTML at the linked documentation example. Compare the output with the GitHub Flavored Markdown specification and the related pdoc issues, focusing on lists, JPG images, and LaTeX in tables and aligned blocks. Done means the included README renders those features correctly.

Written by the indexing model from the issue text.

Assessment

Tech stack
latex, markdown, python
Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.