Where communities thrive


  • Join over 1.5M+ people
  • Join over 100K+ communities
  • Free without limits
  • Create your own community
People
Repo info
Activity
  • May 26 2021 18:38
    ericholscher opened #8216
  • May 26 2021 14:56
    stsewd closed #8214
  • May 26 2021 14:36
    stsewd auto_merge_enabled #8214
  • May 26 2021 14:34
    stsewd synchronize #8214
  • May 26 2021 14:30
    stsewd edited #8214
  • May 26 2021 14:30
    stsewd closed #8213
  • May 26 2021 14:26
    humitos opened #8215
  • May 26 2021 00:07
    stsewd opened #8214
  • May 25 2021 21:13
    stsewd review_requested #8213
  • May 25 2021 21:13
    stsewd opened #8213
  • May 25 2021 20:49
    stsewd review_requested #8212
  • May 25 2021 20:42
    stsewd opened #8212
  • May 25 2021 17:53
    stsewd review_requested #8211
  • May 25 2021 17:34
    stsewd opened #8211
  • May 25 2021 16:36
    stsewd closed #8206
  • May 25 2021 16:28
    stsewd auto_merge_enabled #8206
  • May 25 2021 16:28
    stsewd synchronize #8206
  • May 25 2021 15:15
    humitos closed #4783
  • May 25 2021 00:30
    stsewd closed #8157
  • May 25 2021 00:21
    stsewd auto_merge_enabled #8157
Anthony
@agjohnson
though, even with proper deprecation notices and semver, we can't assume that most users will pick up on deprecations even
Aaron Carlisle
@Blendify
understandable, especially with the commercial side of rtd
Anthony
@agjohnson
if we had been collecting data on sphinx + sphinx theme version usage, this would be a lot easier
we did add this to our roadmap, but doesn't help us immediately
the best outcome for any of these scenarios would be that the build should fail entirely
Aaron Carlisle
@Blendify
Dropping sphinx 1.6 and 1.7 could be a test also to judge the fallout of a bigger breaking change
Anthony
@agjohnson
if we hit a version mismatch issue, or some other deprecation, etc
i've lost track, what requires us to drop 1.6 and 1.7?
could we instead float along with 1.6 and 1.7 until we drop all of 1.x and go 2+?
Aaron Carlisle
@Blendify
Nothing particular it just breaks up the number of affected users
Anthony
@agjohnson
aye
Aaron Carlisle
@Blendify
dropping 1.6 and 1.7 would only affect about half the installs (in theory) if we were to just drop 1.x
Both 1.6 and 1.8 have about 15k downloads per month so dropping 1.6 and 1.7 would drop ~15k while dropping 1.x would drop ~30k
its hard to say though because this is just sphinx and doesn't link to rtd or which theme the users use.
Anthony
@agjohnson
yeah absolutely, i regret not tracking more build metadata here sooner
Aaron Carlisle
@Blendify
I am just worried of the sphinx2 jump because that drops html4 and python2 I don't want to make that a huge burden when we don't know what the fallout would be for even dropping 1.6x
Anthony
@agjohnson
we can do sphinx 2 + html4 -- html4 is dropped in ... 3.0?
Aaron Carlisle
@Blendify
and drop 1.x in v2?
Anthony
@agjohnson
yeah, i think so?
not sure which direction i'm leaning towards at the moment
Aaron Carlisle
@Blendify
Yeah could work, but doesn't really solve anything except getting v1 released sooner
I was kinda partial to matching the major theme version with the major sphinx version
So if users want to use theme v2 they know they need sphinx v2
Anthony
@agjohnson
ah yeah, i don't think we'd be able to keep that up for too long
i'm sort of leaning towards keeping sphinx deprecations out of the picture until we have a reason to -- like dropping html4 writer support (with the bootstrap theme release?)
that is, figure out what we want to fix before closing the development line that include wyrm styles, and then do a big step up
Aaron Carlisle
@Blendify
Well technically we dont even use the html4 doctype so we currently kinda depend on sphinx2
It seems the theme never really used the html4 doctype :/
Aaron Carlisle
@Blendify
So technically we could use bootstrap with 1.6 or anyversion. Its just easier to support sphinx to prevent the use of if statements everywhere. https://github.com/readthedocs/sphinx_rtd_theme/blob/master/sphinx_rtd_theme/__init__.py#L36 is kinda becoming a mess
Anthony
@agjohnson
yeah for the theme, html4 support was more like is more like "not html5"
Aaron Carlisle
@Blendify
lol
Anthony
@agjohnson
i was just considering if it made sense to support both wyrm/bootstrap for a release or two, and make the theme selectable with an option or something
i can't decide if that is better or worse for maintenance though
Aaron Carlisle
@Blendify
I dont think that really solves anything, I think could make it worse for maintenance. RIpping off the bandaid would be better.
Dalton Smith
@Daltz333
@stsewd got hoverxref working for mathjax3
image.png
It wasn't horribly difficult to figure out, although MathJax API docs are pretty garbage. I wanted to run it async but that didn't turn out very good with the hover tooltip, so I opted out of that. You might notice that it doesn't update a specific element anymore. That's because MathJax3 caches current vs changed math, so it's not necessary to update a specific element. Additionally, their promise().then() API which is for updating a specific element is only when you want to update one specific thing that changed, versus all things that changed... additionally, I couldn't figure it out.
Manuel Kaufmann
@humitos
@Daltz333 thanks for your PR! I took a quick look and it's great! I'll do a full review soon hopefully
Benjamin Balder Bach
@benjaoming
It's been up a few times over the years, but just asking again in case someone here knows: Integrations to support building or importing AsciiDoc projects with Sphinx or Read the Docs, do they exist? (also bonus question: anyone doing Spring REST docs?)
Nguyen Quang Minh
@minhng99
hmmm...
i wonder what RTFD means
(:
Benjamin Balder Bach
@benjaoming
It means Read the Fabulous Docs :)
Anthony
@agjohnson
Note: we are going to adopt Gitter communities and use our GitHub readthedocs namespace for new channels. We aren't yet formally moving this channel, but we will be pointing new community discussions to https://gitter.im/readthedocs/community and there are additional channels in our community for specific development topics: https://gitter.im/readthedocs/
Olivier LEMAIRE
@osfe_gitlab
Hi there. Maybe a stupid question but is it possible to generate simple [badly] documented of uncommented code like doxygen does ?
also, how do you inline document your code in c++ ?
something like extracting docstrings for c++ ?