Split the docs for "Standard Library" into "Base" and "Standard Library" #24461
Conversation
|
💯 |
ararslan
added
domain:docs
|
This pull request brings the discussion in #23876 (comment) to mind. Migrating to |
|
Personally, I find the Base / Standard Library distinction to work quite well. Standard packages sounds a bit like an oxymoron to me. |
KristofferC
force-pushed
the
kc/restructure_docs
branch
2 times, most recently
from
35dac2e
to
70a7d3b
Compare
KristofferC
force-pushed
the
kc/restructure_docs
branch
from
70a7d3b
to
decfbec
Compare
|
Alright, updated this. For those places in the Base documentation that were referring to Base as "the standard library", I changed this to "Julia Base". Any other suggestions? There are a few places in the Manual section (Date and Datetime, Profiling) that should probably be moved completely to their stdlib documentation, but this can be done later. I also took the opportunity to do a few things a bit more programmatically because I notice people miss some of the manual steps when moving out stuff to a new stdlib (add to .gitignore etc). This is no longer WIP so please review. |
KristofferC
changed the title
|
Timeout on one Appveyor worker. |
|
|
||
| makedocs( | ||
| build = joinpath(pwd(), "_build/html/en"), | ||
| modules = [Base, Core, BuildSysImg, DelimitedFiles, Test, Mmap, SharedArrays, Profile, | ||
| Base64, FileWatching, Dates, IterativeEigensolvers, Unicode, Distributed, Printf], | ||
| modules = [Base, Core, BuildSysImg, [Module(stdlib.stdlib) for stdlib in STDLIB_DOCS]...], |
There was a problem hiding this comment.
Does this work? I thought Module(x) made a new empty module.
Great change though 👍
There was a problem hiding this comment.
I thought
Module(x)made a new empty module.
Well, clearly you haven't been programming Julia long enough...
It works in the sense that the docs render correctly as far as I can see.
There was a problem hiding this comment.
That's weird; something is up. stdlib.stdlib is a Symbol right?
julia> using Unicode
julia> Module(:Unicode) === Unicode
false
There was a problem hiding this comment.
Ok, it is wrong but the reason it still work, I think, is that none of the stdlib modules have any submodules, which is what Documenter uses this information. Will correct.
The docs right now is split into Manual and Standard Library (and Developer Docs). However, we are now more and more differentiating between what is part of "Base" and what is the "Standard Library". Therefore, I think it makes sense to split the header that is currently called "Standard Library" into two parts; one called "Base" (corresponding to functionality in the
basefoler) and one called "Standard Library" (which corresponds to the modules instdlib).WIP because the introduction to Base needs to be rewritten to not call it the Standard Library, and because there should probably be an introduction corresponding to the Standard Library header.