diff --git a/.gitmodules b/.gitmodules deleted file mode 100644 index 1875291b..00000000 --- a/.gitmodules +++ /dev/null @@ -1,3 +0,0 @@ -[submodule "vendor/Pod-To-HTML"] - path = vendor/Pod-To-HTML - url = https://github.com/perl6/Pod-To-HTML diff --git a/.travis.yml b/.travis.yml index e409f596..15942b74 100644 --- a/.travis.yml +++ b/.travis.yml @@ -6,9 +6,6 @@ rvm: - 2.2.7 - 2.3.4 - 2.4.1 - - jruby-9.1.9.0 -jdk: - - oraclejdk8 notifications: email: false git: @@ -18,7 +15,7 @@ before_install: - echo "deb https://dl.bintray.com/nxadm/rakudo-pkg-debs `lsb_release -cs` main" | sudo tee -a /etc/apt/sources.list.d/rakudo-pkg.list - sudo apt-get update -qq - sudo apt-get install perl rakudo-pkg - - export PATH=$PATH:/.perl6/bin:/opt/rakudo-pkg/bin && install-zef-as-user && zef install Pod::To::HTML + - export PATH=$PATH:/.perl6/bin:/opt/rakudo-pkg/bin - curl -L http://cpanmin.us | perl - --sudo App::cpanminus - sudo cpanm --installdeps --notest Pod::Simple - sudo pip install docutils @@ -28,6 +25,3 @@ cache: env: global: - "JRUBY_OPTS=-Xcext.enabled=true" -matrix: - allow_failures: - - rvm: jruby-9.1.9.0 diff --git a/github-markup.gemspec b/github-markup.gemspec index 2459b753..88212c66 100644 --- a/github-markup.gemspec +++ b/github-markup.gemspec @@ -12,7 +12,7 @@ Gem::Specification.new do |s| s.license = "MIT" s.files = `git ls-files`.split($\) - s.files += Dir['vendor/Pod-To-HTML/**/*'] + s.files += Dir['vendor/**/*'] s.executables = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) } s.test_files = s.files.grep(%r{^(test|spec|features)/}) s.require_paths = %w[lib] diff --git a/lib/github/commands/pod62html b/lib/github/commands/pod62html index e9e5316a..b2d27764 100755 --- a/lib/github/commands/pod62html +++ b/lib/github/commands/pod62html @@ -1,10 +1,5 @@ #!/usr/bin/env perl6 use v6; -use lib $*PROGRAM.IO.parent.add: '../../../vendor/Pod-To-HTML'; -use Pod::To::HTML; -$_ = Pod::To::HTML.render(slurp); -s:s{\<\!doctype html\>.*\
\<\/div\>\s*} = ""; -s:s{\s*\<\/div\>\s*\<\/body\>\s*\<\/html\>\s*} = ""; -.put; +slurp.put; diff --git a/test/markups/README.pod6 b/test/markups/README.pod6 deleted file mode 100644 index c780c5be..00000000 --- a/test/markups/README.pod6 +++ /dev/null @@ -1,151 +0,0 @@ -=begin pod - -=TITLE About the Docs - -=SUBTITLE Meta-documentation - -This document collection represents the on-going effort to document the 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. - -An HTML version of the documentation is located online at -L. - -The official source for this documentation is located at L. - -This particular document is a quick overview of the process -described in more detail in L. -This document also provides a short introduction to writing Perl 6 -Pod files, which can be rendered into HTML and other formats. - -=head1 Structure - -All of the documentation is written in Perl 6 Pod and kept in the C -directory, and the C and C sub-directories. -These files are processed as collections of definitions or -"documentables", which are then post-processed and linked together. - -=head1 Generating HTML from Pod - -To generate HTML from the Pod files, you'll need: - -=item A recent version of the Rakudo Perl 6 compiler - -=item The Perl 6 modules Pod::To::HTML, Pod::To::BigPage, and URI::Escape -(can be installed via L). - -=item B: L, for creating graphs -of the relationships between Perl 6 types - -=item B: L and L, for syntax -highlighting - -To generate the documentation into the C folder, run: - -=begin code :lang -perl6 htmlify.p6 -=end code - -To host the documentation from a web server, have Perl 5 -and Mojolicious::Lite installed, then run: - -=begin code :lang -perl app.pl daemon -=end code - -=head1 Contributing - -The documentation is written in Perl 6 Pod. - -For a quick introduction to Perl 6 Pod, see L. - -For full details about the Perl 6 Pod specification, see L. - -=head2 Adding definitions - -Documentables can be defined using an C<=headN> Pod directive, where -C is greater than zero (e.g., C<=head1>, C<=head2>, …). - -All of the paragraphs and blocks following that directive, up until the -next directive of the same level, will be considered part of the -documentable. So, in: - -=begin code :allow :skip-test -=head2 R - -Some paragraphs, followed by some code: - - my Code $examples = "amazing"; - -Mind === blown. - -=head3 Minor details about R - -It's fantastic. - -=head2 And now, for something completely different - -… - -=end code - -The documentable R extends down to the C<=head2 And now…>. - -Documentables may contain other documentables. Class documentables, for -example, often contain the methods the class implements. - -Definitions must be in one of the following forms to be recognized as -the start of a documentable named, say, þ. First the code in the document source: - -=begin code :skip-test - -=item X | infix,þ> (This a special case, which -is always considered a definition) - -=item C - -=item B Infix> - -=item C - -=item B> - -=item C (A special case for the L documentables) - -=end code - -Then the results on the rendered page: - -=item X | infix,þ> (This is a special case, which -is always considered a definition) - -=item C - -=item B Infix> - -=item C - -=item B> - -=item C (A special case for the L documentables) - -These items should now be searchable by using the search field in the HTML docs. - -You can add emphasis with bold (B >>) or italicized (B >>), -with or without code formatting (B >>). Due to current parser limitations, -special steps have to be taken to use B >> with other formatting codes; for example: - -=begin code :skip-test -=item X|foo> a fancy subroutine -=end code - -renders like this - -=item X|foo> a fancy subroutine - -Notice that text after a pipe ('|') has no formatting. Also note that B >> -preserves spaces and treats text as verbatim. -=end pod - diff --git a/test/markups/README.pod6.html b/test/markups/README.pod6.html deleted file mode 100644 index 3b55d843..00000000 --- a/test/markups/README.pod6.html +++ /dev/null @@ -1,128 +0,0 @@ -

About the Docs

-

Meta-documentation

- - -

Table of Contents

- - - - - - - - - - - - - - - - - -
1Structure
2Generating HTML from Pod
3Contributing
3.1Adding definitions
- - -
-

This document collection represents the on-going effort to document the 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.

-

An HTML version of the documentation is located online at https://docs.perl6.org.

-

The official source for this documentation is located at perl6/doc on GitHub.

-

This particular document is a quick overview of the process described in more detail in CONTRIBUTING on GitHub. This document also provides a short introduction to writing Perl 6 Pod files, which can be rendered into HTML and other formats.

-

Structure

-

All of the documentation is written in Perl 6 Pod and kept in the doc/ directory, and the doc/Language/ and doc/Type/ sub-directories. These files are processed as collections of definitions or "documentables", which are then post-processed and linked together.

-

Generating HTML from Pod

-

To generate HTML from the Pod files, you'll need:

-
    -
  • -

    A recent version of the Rakudo Perl 6 compiler

    -
    • -
  • -

    The Perl 6 modules Pod::To::HTML, Pod::To::BigPage, and URI::Escape (can be installed via zef).

    -
    • -
  • -

    Optional: GraphViz, for creating graphs of the relationships between Perl 6 types

    -
    • -
  • -

    Optional: Atom Highlights and language-perl6, for syntax highlighting

    -
    • -
-

To generate the documentation into the html/ folder, run:

-
perl6 htmlify.p6
-
-

To host the documentation from a web server, have Perl 5 and Mojolicious::Lite installed, then run:

-
perl app.pl daemon
-
-

Contributing

-

The documentation is written in Perl 6 Pod.

-

For a quick introduction to Perl 6 Pod, see Perl 6 Pod.

-

For full details about the Perl 6 Pod specification, see Synopsis 26, Documentation.

-

Adding definitions

-

Documentables can be defined using an =headN Pod directive, where N is greater than zero (e.g., =head1, =head2, …).

-

All of the paragraphs and blocks following that directive, up until the next directive of the same level, will be considered part of the documentable. So, in:

-
=head2 My Definition
-
-Some paragraphs, followed by some code:
-
-    my Code $examples = "amazing";
-
-Mind === blown.
-
-=head3 Minor details about My Definition
-
-It's fantastic.
-
-=head2 And now, for something completely different
-
-…
-
-
-

The documentable My Definition extends down to the =head2 And now….

-

Documentables may contain other documentables. Class documentables, for example, often contain the methods the class implements.

-

Definitions must be in one of the following forms to be recognized as the start of a documentable named, say, þ. First the code in the document source:

-
=item X<C<How to use the þ infix> | infix,þ> (This a special case, which
-is always considered a definition)
-
-=item C<The þ Infix>
-
-=item B<The C<þ> Infix>
-
-=item C<Infix þ>
-
-=item B<Infix C<þ>>
-
-=item C<trait is cached> (A special case for the L<trait|/language/functions#Traits> documentables)
-
-
-

Then the results on the rendered page:

-
    -
  • -

    How to use the þ infix (This is a special case, which is always considered a definition)

    -
    • -
  • -

    The þ Infix

    -
    • -
  • -

    The þ Infix

    -
    • -
  • -

    Infix þ

    -
    • -
  • -

    Infix þ

    -
    • -
  • -

    trait is cached (A special case for the trait documentables)

    -
    • -
-

These items should now be searchable by using the search field in the HTML docs.

-

You can add emphasis with bold ( B<> ) or italicized ( I<> ), with or without code formatting ( C<> ). Due to current parser limitations, special steps have to be taken to use X<> with other formatting codes; for example:

-
=item X<B<foo>|foo> a fancy subroutine
-
-

renders like this

-
    -
  • -

    foo a fancy subroutine

    -
    • -
-

Notice that text after a pipe ('|') has no formatting. Also note that C<> preserves spaces and treats text as verbatim.

-
\ No newline at end of file diff --git a/vendor/Pod-To-HTML b/vendor/Pod-To-HTML deleted file mode 160000 index f5ea68c2..00000000 --- a/vendor/Pod-To-HTML +++ /dev/null @@ -1 +0,0 @@ -Subproject commit f5ea68c2bb2145dc79f26bf1d9489acb36c0461c