Just from this blog alone, I have begun to develop
-
sphinx-fediverse (released)
-
sphinx-cw (prototyping, for content warnings)
-
sphinx-citeas (concept, for adding a snippet to generate citations for your page)

#Sphinx #Python #SphinxDoc
Good news! sphinx-fediverse is now out of beta and has a stable release! It'a ready to go for enabling comments sections in your Sphinx-generated web pages

#Python #SphinxDoc #FOSS #FLOSS #OSS #FediBridge #Mastodon #Misskey #Sharkey #Fediverse #Fedi
I decided it was time to put together a single documentation website for all my #RiverTemperature software (https://www.rivertempest.org/) and I would just like to say that #sphinxdoc is a wonderful tool. Super straightforward to get everything up and running, looks good, has working search, etc. Not to mention automatically generating HTML documentation from the comments in my code.
TempEst Modeling — RiverTempest.org

sphinx-fediverse 0.9.0 is now released. This is likely the last beta release. Since the previous version...

New features:
- Per-directive overrides of global options
- Automatic linting of CSS
- Ability to use multiple fedi instances/flavors in one project
- Significantly increase support for Misskey Flavored Markdown (blur, flip, scale, bg/fg color, ruby text, font, border)
- Significantly more tests (overall code coverage ~70%)

Bug fixes:
- Fix some MFM rendering errors
- Fix Misskey not reporting global boosts correctly

#Python #SphinxDoc #FOSS #FLOSS #OSS #FediBridge #Mastodon #Misskey #Sharkey #Fediverse #Fedi
Discussion post for Developing sphinx-fediverse

--------------------------

A few months ago, I had an idea. What if I could use the Fediverse to embed comments in my sphinx-generated pages?

It turned out I wasn’t the first to think of this. Many others have used this kind of thing to power the comments of their blogs. Enough so that it was easy to find references on how to implement it.

The main difficulty was the way I wanted to go about it. I wanted it to be a sphinx plugin, and I wanted it to be both flexible and configurable. This post covers the challenges I encountered.

#Python #SphinxDoc #FOSS #FLOSS #OSS #FediBridge #Mastodon #Misskey #Sharkey #Fediverse #Fedi #JavaScript
Developing sphinx-fediverse

Ja się nie dziwię że programiści nie chcą dokumentować swoich programów. Weź ustaw sfinksa że wszystkimi plaginami 🤦

#programowanie #sphinxdoc

sphinx-fediverse 0.8.0 is now released. Since the previous version...

New features:
- Support for custom emoji in non-reaction content on Misskey
- Support for individual media to be marked as sensitive (mostly in Misskey)
- Support for account-wide content warnings in Misskey
- Comment parsing now done with async methods

Bug fixes:
- Corrected a typo in article reaction rendering
- More CSS changes related to word wrap
- Fixed a bug in
replaceEmoji() that caused only the first paragraph of posts to be rendered

Likely next steps:
- Custom emoji in reactions
- Find a better way to sanitize Misskey posts
- Verify that Mastodon actually returns sanitized HTML (and remove the worst parts if not)
- Adapt
replaceEmoji() to directly produce DOM elements instead of relying on the parser

Special thanks to
@hazelnoot for pushing me to rewrite the render code

#Python #SphinxDoc #FOSS #FLOSS #OSS #FediBridge #Mastodon #Misskey #Sharkey #Fediverse #Fedi
sphinx-fediverse 0.7.0 is now released. Since the previous version...

New features:
- Improved rendering security! It no longer relies on a massive HTML template. Still some progress to make
- Support for unicode emoji reactions on Misskey instances
- If a comment is too wide for the page, it will now split the username, so:
@[email protected] will become @LivInTheLookingGlass\[email protected]
- Increased use of the comment parser to avoid ambiguities
- Comment posts will now include the title of the article and, if on Misskey, put the link on that text
- Misskey now supports the following parts of MFM:
- anything in standard Markdown
- mentions
- hashtags
-
<small>
-
<center>
-
<i>
-
<plain>

Bug fixes:
- Bumped the version of an insecure dependency

Extra shout-out to the people who "bullied" me into fixing the render code. It's not perfect, but it's a lot better now. Figuring out a better way to

1. sanitize MFM input
2. adapt
replaceEmoji() to work with DOM elements
3. get custom emoji working for Misskey instances

are probably the last real blockers before a 1.0 release. There's a few more Misskey-related things that would be nice, but it's mostly about increasing parity at that point

#Python #SphinxDoc #FOSS #FLOSS #OSS #FediBridge #Mastodon #Misskey #Sharkey #Fediverse #Fedi
Which of these issues should I tackle next? I leaning towards render support for emoji reactions (but not custom ones, because I still need to figure that out for Misskey)

https://github.com/LivInTheLookingGlass/sphinx-fediverse/issues/

#Python #SphinxDoc #FOSS #FLOSS #OSS #FediBridge #Mastodon #Misskey #Sharkey #Fediverse #Fedi
Issues · LivInTheLookingGlass/sphinx-fediverse

Enable comments for your sphinx page, conveniently hosted on Mastodon or Misskey - Issues · LivInTheLookingGlass/sphinx-fediverse

GitHub
sphinx-fediverse 0.6.0 is now released. Since the previous version...

New features:
- (Standard) Markdown rendering for Misskey instances (more MFM support to come later)
- Support (in parser only) for emoji-based reactions
- Support (in parser only) for sensitive images among non-sensitive images
- Dump the post-to-page mapping to _static/ for ease of debug
- Support for reply handling on Misskey instances

Bug fixes:
- Icons previously wouldn't show for posts outside the root directory
- A typo led to a duplicate icon
- Shibuya dark now produces legible icons (and this should be portable to other themes)
- the hover effect no longer renders text unreadable on Shibuya dark (again, should be portable)

#Python #SphinxDoc #FOSS #FLOSS #OSS #FediBridge #Mastodon #Misskey #Sharkey #Fediverse #Fedi