Skip to content

Document with Sphinx#15

Open
lucmann wants to merge 2 commits intokhuttun:masterfrom
lucmann:document
Open

Document with Sphinx#15
lucmann wants to merge 2 commits intokhuttun:masterfrom
lucmann:document

Conversation

@lucmann
Copy link

@lucmann lucmann commented Aug 3, 2024

Achieve this via Doxygen+Sphinx+breathe+gh-pages. The resulting
index.html resides builddir/docs/sphinx. Furthermore, as long as
with simple step to enable GitHub Pages in your own project(even if forked),
the well-rendered documentation site should be live on
https://user.github.io/PolyM/ (replace USER)

lucmann added 2 commits August 2, 2024 08:30
Signed-off-by: Luc Ma <luc@sietium.com>
Achieve this via Doxygen+Sphinx+breathe+gh-pages. The resulting
index.html resides builddir/docs/sphinx. Furthermore, as long as
with simple step to enable GitHub Pages in your own project(even if forked),
the well-rendered documentation site should be live on
https://USER.github.io/PolyM/ (replace USER)

Signed-off-by: Luc Ma <luc@sietium.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant