An HTML version of this documentation can be found at https://docs.perl6.org/. This is currently the recommended way to consume the documentation.
There is also a command line tool called
p6doc, which you can use to
browse the documentation once it's installed (see below).
This documentation is also published as
container. It includes a copy of the web published on port 3000, so you
can run it with:
docker run --rm -it -p 3000:3000 jjmerelo/perl6-doc
docker run --rm -it -p 31415:3000 jjmerelo/perl6-doc
in case you want it published somewhere else. You can direct your browser to http://localhost:3000 (or 31415, as the case may be).
This module is available via the PerlÂ 6 module ecosystem. Use:
$ zef install p6doc
to install the "binaries" and make them available in your binaries execution path.
Note: Please note that, due to changes in the parsing of Pod6,
this will fail in versions of PerlÂ 6 older than 2018.06. Please upgrade to that
version, or install using
With a Rakudo
perl6 executable in the
$ ./bin/p6doc Str
to see the documentation for class
$ ./bin/p6doc Str.split
to see the documentation for method
split in class
Str. You can
./bin part if you have installed it via
zef. You can also do:
$ p6doc -f slurp
to browse the documentation of standard functions (which, in this particular case, will actually return multiple matches, which you can check individually). Depending on your disk speed and Rakudo version, it might take a while.
You might want to have a copy of the documentation and run the web site locally yourself. In that case, install dependencies by running the following in the checkout directory:
$ zef --deps-only install .
If you use
rakudobrew, also run the
following, to update the shims for installed executables:
$ rakudobrew rehash
In addition to the PerlÂ 6 dependencies, you need to have
graphviz installed, which
on Debian you can do by running:
$ sudo apt-get install graphviz
To build the documentation web pages, simply run:
$ make html
For best results, we recommend that you use the latest released versions, specially any one after 2018.11.
Please note that you will need to have nodejs
installed to produce HTML content with the above command, in particular
node executable should be in your
PATH. Besides, you will need
g++ installed in order to build some of the dependencies
that are installed with nodejs. nodejs is needed only to apply
highlighting to the included code; if you do not want that, simply
$ make html-nohighlight
After the pages have been generated, you can view them on your local
computer by starting the included
$ make run
You can then view the examples documentation by pointing your web browser at http://localhost:3000.
$ cpanm --installdeps .
If you have
pandoc installed, you can also generate an ePub with
$ make epub
PerlÂ 6 is not a small language, and documenting it takes a lot of effort. Any help is appreciated.
Here are some ways to help us:
git grep TODOin this repository, and replace the TODO items by actual documentation.
Q: Why aren't you embedding the docs in the CORE sources?
A: Several reasons:
Q: Should I include methods from superclasses or roles?
A: No. The HTML version already includes methods from superclasses and roles, and the
p6doc script will be taught about those as well.
I want p6doc and docs.perl6.org to become the No. 1 resource to consult when you want to know something about a PerlÂ 6 feature, be it from the language, or built-in types and routines. I want it to be useful to every PerlÂ 6 programmer.
P6_DOC_TEST_VERBOSEto a true value to display verbose messages during test suite run. Helpful when debugging failing test suite.
skip-testcode examples as TODO in
The code in this repository is available under the Artistic License 2.0 as published by The Perl Foundation. See the LICENSE file for the full text.
This repository also contains code authored by third parties that may be licensed under a different license. Such files indicate the copyright and license terms at the top of the file. Currently these include:
the first non-comment or non-empty line must be:
=begin pod # optionally followed by :key<value> %config pairs
the second non-comment or non-empty line must be:
an optional (but usually desired) subtitle must be the third non-comment or non-empty line:
the last non-comment or non-empty line must be:
=begin pod :my-link
=comment a pod comment # a valid comment =end pod
=comment a pod comment # this is not a valid comment in this position
=begin pod :my-link