Include all public docstrings in the manual

[MichaelHatherly]

Currently there are a significant number (200+) docstrings in Base and it's submodules
that are not included in the manual anywhere. To see the current list of docstrings that
still need to be included change the following line in doc/make.jl

    checkdocs = :none,

to

    checkdocs = :all,

and build the docs with

make docs

from the root directory.

There's some docstrings for names that are exported and should definitely find there way into the manual somewhere, as well as quite a few internal docstrings that probably don't need to be included or could do with some improvements before inclusion.

(I'm marking this issue as up-for-grabs since it can readily be distributed between many contributors.)

[tkelman]

And these weren't included in the rst manual either?

[MichaelHatherly]

Yes, none of them were ever included in the manual, so this would just be adding extra docstrings to the manual.

[tkelman]

I'm seeing several html files missing from gh-pages that were present in the previous html output:

devdocs/C.html
devdocs/julia.html
stdlib/stacktraces.html

[MichaelHatherly]

Source files still exist as far as I can see, just weren't included in makedocs. C.md and julia.md are just "index" pages, which just duplicate what's already in the side menu, so they can probably just be removed. I'll add back stacktraces.md though.

[mortenpi]

The current state is that we have 195-ish docstrings attached to exported names that are not spliced into the manual (and 581 total). I say "-ish" because some of the ones on the list are just exports from internal modules and not part of the public API.

• All the missing docstrings of exports should be added to their respective manual pages.
• Check this on CI. Documenter's checkdocs = :exports almost does this, but does get confused by the exports from internal modules. It should probably just check for exports from the top-level modules.

[IanButterworth]

The number of checkdocs = :exports is up to 298 now. #55267 (comment)

[IanButterworth]

I've renamed this issue to be about public docstrings, as I think that's the correct requirement.

Automatically enforcing it requires a Documenter.jl feature JuliaDocs/Documenter.jl#1506