Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Removing references from the documentation and updating, refs #2996
  • Loading branch information
JJ committed Sep 1, 2019
1 parent 3adf10d commit faa7981
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 6 deletions.
3 changes: 0 additions & 3 deletions META6.json
Expand Up @@ -22,9 +22,6 @@
"File::Find"
],
"provides": {
"Perl6::Documentable": "lib/Perl6/Documentable.pm6",
"Perl6::Documentable::Registry": "lib/Perl6/Documentable/Registry.pm6",
"Perl6::TypeGraph::Viz": "lib/Perl6/TypeGraph/Viz.pm6",
"Pod::Cache": "lib/Pod/Cache.pm6",
"Pod::Convenience": "lib/Pod/Convenience.pm6",
"Pod::Htmlify": "lib/Pod/Htmlify.pm6",
Expand Down
15 changes: 12 additions & 3 deletions doc/Language/about.pod6
Expand Up @@ -5,7 +5,7 @@
=SUBTITLE Meta-documentation
This document collection represents the on-going effort to document the
Perl 6 programming language with the goals of being: comprehensive,
Perl 6 programming language with the goals of being comprehensive,
easy to use, easy to navigate, and useful to both newcomers and experienced
Perl 6 programmers.
Expand Down Expand Up @@ -38,6 +38,9 @@ To generate HTML from the Pod files, you'll need:
which all can be installed via L<zef|https://github.com/ugexe/zef>. For
instance, C<zef install Pod::To::HTML> to install Pod::To::HTML.
=item L<C<Documentable>|https://modules.perl6.org/dist/Documentable>, the
document API.
=item B<Optional>: L<GraphViz|https://www.graphviz.org>, for creating graphs
of the relationships between Perl 6 types.
Expand All @@ -48,11 +51,17 @@ highlighting.
To generate the documentation into the C<html/> folder, run:
=begin code :lang<shell>
perl6 htmlify.p6
documentable start -a -v --highlight
=end code
To host the documentation from a web server, have Perl 5
and Mojolicious::Lite installed, then run:
and Mojolicious::Lite installed; if you have Perl, run
=for code
cpanm --installdeps .
and then run:
=begin code :lang<shell>
perl app.pl daemon
Expand Down

0 comments on commit faa7981

Please sign in to comment.