Perl 6 JavaScript CSS Makefile Shell Perl Other
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github Eliminates more tabs Apr 15, 2018
assets Don't sort operators precedence table Apr 17, 2018
bin fix typo Sep 25, 2017
doc Add a useful .pull-one example Apr 21, 2018
highlights Address warnings about the package.json file Apr 8, 2018
html Revert "Ensure html/js dir exists" Apr 9, 2018
lib Micro-optimize &rewrite-url routine Apr 2, 2018
t Allow newline at end of extracted SVG code Apr 2, 2018
template Revert 7a3168f and add back WARNING in template/search_template.js Apr 16, 2018
util Adds a faster Docker container based test process. Apr 15, 2018
writing-docs Trailing whitespace. Apr 14, 2018
xt Allow the plural as well Apr 16, 2018
.dockerignore Modified Dockerfile for building/hosting docs Oct 29, 2017
.gitignore Implement assets generator Apr 2, 2018
.travis.yml remove trailing whitespace Apr 16, 2018
Build.pm Fix RT#131025 which is due to Build.pm failing to install docs under Jun 22, 2017
CONTRIBUTING.md Eliminates tab Apr 13, 2018
CREDITS Add fluca1978 (myself) to credits. Apr 6, 2018
Dockerfile Modified Dockerfile for building/hosting docs Oct 29, 2017
LICENSE No more trailing whitespace (EVERYWHERE!) May 20, 2016
META6.json Updates version for LWP::Simple closes #1928 Apr 15, 2018
Makefile Eliminates debug code Apr 17, 2018
README.md Merge license stuff in README Apr 17, 2018
README.zh.md Update README.zh.md Apr 17, 2018
app-start Implement assets generator Apr 2, 2018
app.pl Add table sorter jQuery plugin Apr 2, 2018
cpanfile Implement assets generator Apr 2, 2018
htmlify.p6 Update htmlify.p6 Apr 16, 2018
shippable.yml [Shippable] Cache modules dir Apr 17, 2018
type-graph.txt List HyperWhatever in type graph Apr 2, 2018
type-groups.json categorise more types Feb 18, 2017

README.md

Official Perl 6 Documentation

Build Status artistic

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".

(If you are browsing this repository via GitHub, it will not display most files correctly, because this is Perl 6 Pod, and GitHub assumes Perl 5 POD).

README in other languages

Install p6doc

This module is available via the Perl 6 module ecosystem. Use

zef install p6doc

to install the binaries and make it available in your binaries execution path.

Use p6doc

With a Rakudo perl6 executable in PATH, try

./bin/p6doc Str

to see the documentation for class Str, or

./bin/p6doc Str.split

to see the documentation for method split in class Str. You can skip the ./bin part if you have installed it via zef. You can also do

p6doc -f slurp

to browse the documentation of standard functions. Depending on your disk speed and Rakudo version, it might take a while.


Building the HTML documentation

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

Please note that you will need to have nodejs installed to produce HTML content with the above command, in particular a node executable should be in your PATH.

After the pages have been generated, you can view them on your local computer by starting the included app.pl program:

$ make run

You can then view the examples documentation by pointing your web browser at http://localhost:3000.

You will need at least Mojolicious installed and you will need nodejs to perform highlighting. There are also some additional modules you might need; install them all using

$ cpanm --installdeps .

Help Wanted!

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:

  • add missing documentation for classes, roles, methods or operators
  • add usage examples to existing documentation
  • proofread and correct the documentation
  • tell us about missing documentation by opening issues on github.
  • Do a git grep TODO in this repository, and replace the TODO items by actual documentation.

Issues page has a list of current issues and documentation parts that are known to be missing and the CONTRIBUTING document explains briefly how to get started contributing documentation.


Some notes:

Q: Why aren't you embedding the docs in the CORE sources?
A: Several reasons:

  1. This documentation is intended to be universal with respect to a given version of the specification, and not necessarily tied to any specific Perl 6 implementation.
  2. Implementations' handling of embedded POD is still a bit uneven; this avoids potential runtime impacts.
  3. A separate repo in the perl6 Github account invites more potential contributors and editors.

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.


Vision

I want p6doc and doc.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.

-- moritz


ENV VARS

  • P6_DOC_TEST_VERBOSE to a true value to display verbose messages during test suite run. Helpful when debugging failing test suite.
  • P6_DOC_TEST_FUDGE fudges skip-test code examples as TODO in xt/examples-compilation.t test

LICENSE

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: