ecceaba1c5
I recently noticed that the doc string for `Base.@ccallable` is not included in the docs. Given how often it is used with PackageCompiler.jl and JuliaC.jl at this point, I assume it was just an oversight, and not an intentional exclusion.
Julia Documentation README
Julia's documentation is written in Markdown. A reference of all supported syntax can be found in the manual. All documentation can be found in the Markdown files in doc/src/ and the docstrings in Julia source files in base/ and stdlib/.
Requirements
This documentation is built using the Documenter.jl package.
All dependencies are automatically installed into a sandboxed package directory in doc/deps/ to avoid interfering with user-installed packages.
Building
To build Julia's documentation run
$ make docs
from the root directory. This will build the HTML documentation and output it to the doc/_build/ folder.
Testing
To run the doctests found in the manual run
$ make -C doc doctest=true
from the root directory.
Customizing Doctest Execution
By default, doctests are run using the in-tree Julia executable.
This behavior can be changed by setting the JULIA_EXECUTABLE Makefile variable.
Warning
Using a custom
JULIA_EXECUTABLEwill not pick up changes to docstrings for Base or any standard library built into the system image. To see the list of standard libraries that are part of the system image, you can run thecontrib/print_sorted_stdlibs.jlscript (e.g.,julia contrib/print_sorted_stdlibs.jl --only-sysimg).