https://www.dendron.so/ logo
Powered by
Hello everyone! I would like to publish my Dendron...
# questions
n
Hello everyone! I would like to publish my Dendron notes/documentation through Sphinx. Has anyone done something similar? It would be lovely to co-op the project with multiple teammates as well 🙂
k
not the same but i know @codeluggage was working on programatically translating docs into dendron. also tagging @ScriptAutomate
s
This is something I have had in my backlog of things to try out, but I haven't worked on testing or playing with yet. I feel like it may require a bit of work in regard to Sphinx, especially because of things like 
rst
, or if people are using 
myST
, if people are using autodoc, etc. and how to work with those docs, and if themes/extensions people are using are making things more complex
Some previous thought of mine on Sphinx from the Discord: > I'm trying to figure this out with Python projects that are heavily setup with Sphinx, and using things like autodoc generation from function comments. I'm thinking of playing around with something like: > - Sphinx gen HTML > - Convert HTML to Markdown > - Import Markdown to Dendron vault > I still need to look at other tools like pydoc-markdown that seem to be built for the purpose of converting Sphinx-style stuff into Markdown docs, which could then be used by other tools like Dendron, Hugo, etc.
Also, some of the issues I mentioned in my recent Greenhouse Talk (admonitions; embed/include contents of separate code files directly into dendron notes; etc.) will be part of tackling some things, I think. If I could dive into the 
pydoc-markdown
at some point, it would likely be a big help, since it looks like it would be able to read docstrings and convert the content into Markdown output, for example
I don't have experience with it, but if you have Python powers, could be worth a shot to look at it: https://github.com/NiklasRosenstein/pydoc-markdown
c
The project I was working on for this kept being pushed back, and was then put on ice recently, sadly :/ The concept was to integrate pod export + import during the build step of a JS based repo. By extracting comments from the code and verifying that [[links.to.hierarchies.in.the.knowledgebase]] were correct, the code could be verifiably "rot protected". On the knowledge base side (Dendron), the [[links.to.code.folder.then.file.then.function-or-class]] could be verifiably "rot protected". Thus, having a build step on both sides would let you have linked code and knowledgebase, with warnings/pull request rejection if the changes caused rot.
PreviousNext
Powered by