I would like to include structured metadata as JSON-LD in a JupyterBook, e.g. following the https://bioschemas.org/profiles/TrainingMaterial/1.0-RELEASE schema. But JB and Sphinx seem to only support very limited metadata.
Does anyone have experience with this?

#metadata #learningResource #OER #JupyterBook #SphinxDoc

@rgarcia estoy usando #sphinxdoc https://www.sphinx-doc.org/en/master/ que si bien no es para eso, sí sirve y me permite iterar con versionado. Además el resultado es de primera

https://scicomp.aalto.fi is a #Sphinx -generated site using #SphinxRtdTheme. Using #mastofeed, we embedded the @SciCompAalto timeline in the sidebar, and it seems to work well.

Code for copying: https://github.com/AaltoSciComp/scicomp-docs/blob/master/_templates/layout.html

- Anyone have design improvements?
- Mastofeed could use some care if someone has time, for example it suggests adding caching. My main worry is making excessive server load.

#SphinxDoc #documentation

My organization (Software Heritage) is using more and more #pads (using #HedgeDoc) for real-time collaborative elaboration of documentation, presentations, etc.

However, once completed, we have a hard time referencing the content, indexing it, archiving it. Completed documentation pages land in our #SphinxDoc project, which is properly indexed and hyperlinked, but not all of the pad content needs to land there.

Do you know of groups that have existing strategies to make sure that the knowledge stored in pads doesn't end up stuck in that black hole forever? I would especially welcome #git or #GitLab based, automated workflows. #Archivists #KnowledgeManagement

I've found the CERN CodiMD archive project, which seems promising, but, hilariously, only referenced on their own CodiMD instance. I haven't found any code for it.

Seems like #GitLab has killed its real-time collaborative edition project as well, so that seems to be a dead end.

(cc. @douardda @zacchiro, boosts welcome for reach)

Btw, I ended up using sphinxcontrib-newsfeed [1] to generate RSS from #sphinxdoc.

It is far from perfect, but "just works".

[1] https://pypi.org/project/sphinxcontrib-newsfeed

mmm, anybody knows a good extension for #sphinxdoc that export articles/documents as an RSS feed?

What are you using for that (if you do so)?

#python #documentation #rss

Working on #Python for #Scientific #Computing lesson material (#PythonForSciComp) with #sphinxdoc, and I'm again impressed by this hidden feature of #Sphinx.

#Intersphinx lets you connect to other doc sites and point to the primary #documentation by name, e.g. this links directly to the #numpy documentation!:

:py:meth:`numpy.ndarray.astype`

[insert "link all the things" meme]
https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html

Pre-dating Markdown and more general-purpose by design, the reStructuredText format is part of #Docutils; greatly expanded on by the #SphinxDoc project.

Both are #FreeSoftware and exemplars of practical, community design projects.

I'm #ThursdayThankful for #reST: a sensible, readable plain-text markup format with thoughtful design to make it unobtrusive and semantically powerful.

https://docutils.sourceforge.io/

Dear sphinx-doc devs;

I know, I've been (still am) that dev who is convinced some missing feature is wrong headed and/or not worth the trouble. On the other hand, when there are multiple user extensions floating around with names like "fixed_only" and "sane_only", maybe it's time to reconsider how the 'only' directive works in sphinx-doc.

#documentation #PassiveAggressive #SometimesTheUsersAreRight #SphinxDoc