Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Move all docs to doc
  • Loading branch information
coke committed Oct 8, 2015
1 parent 0f38cf1 commit 8249119
Show file tree
Hide file tree
Showing 257 changed files with 7 additions and 7 deletions.
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Expand Up @@ -19,9 +19,9 @@ in the [#perl6 IRC channel](http://perl6.org/community/irc).

## Documenting types

The POD documentation of types is located in the `lib/Type` directory and
The POD documentation of types is located in the `doc/Type` directory and
subdirectories of this repository. For example the POD of `X::Bind::Slice`
lives in `lib/Type/X/Bind/Slice.pod`.
lives in `doc/Type/X/Bind/Slice.pod`.

To start contributing fork and checkout the repository, find the document
you want to improve, commit your changes, and create a pull request. Should
Expand All @@ -33,7 +33,7 @@ with the helper tool `util/new-type.p6`. Say you want to create `MyFunnyRole`:

$ perl6 util/new-type.p6 MyFunnyRole

Fill the documentation file `lib/Type/MyFunnyRole.pod` like this:
Fill the documentation file `doc/Type/MyFunnyRole.pod` like this:

=TITLE role MyFunnyRole

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
8 changes: 4 additions & 4 deletions htmlify.p6
Expand Up @@ -158,12 +158,12 @@ sub MAIN(
}

sub process-pod-dir($dir, :&sorted-by = &[cmp], :$sparse) {
say "Reading lib/$dir ...";
say "Reading doc/$dir ...";
my @pod-sources =
recursive-dir("lib/$dir/")\
recursive-dir("doc/$dir/")\
.grep({.path ~~ / '.pod' $/})\
.map({;
.path.subst("lib/$dir/", '')\
.path.subst("doc/$dir/", '')\
.subst(rx{\.pod$}, '')\
.subst(:g, '/', '::')
=> $_
Expand Down Expand Up @@ -590,7 +590,7 @@ sub write-disambiguation-files () {
sub write-index-files () {
say 'Writing html/index.html ...';
spurt 'html/index.html',
p2h(EVAL(slurp('lib/HomePage.pod') ~ "\n\$=pod"),
p2h(EVAL(slurp('doc/HomePage.pod') ~ "\n\$=pod"),
pod-path => 'HomePage.pod');

say 'Writing html/language.html ...';
Expand Down

6 comments on commit 8249119

@mattn
Copy link

@mattn mattn commented on 8249119 Oct 10, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After this change, p6doc -f push show not found.

@skaji
Copy link

@skaji skaji commented on 8249119 Oct 10, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Indeed.

@stmuk
Copy link
Contributor

@stmuk stmuk commented on 8249119 Oct 12, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The p6doc command line tool should now be fixed by

c90c919bcd

There are still some minor issues with "p6doc -f" which I shall fix shortly.

@skaji
Copy link

@skaji skaji commented on 8249119 Oct 12, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@stmuk Thanks!

just a note: Panda shows what are copied. So I think it's nice p6doc follows that.

diff --git Build.pm Build.pm
index fb7199d..f8b82d0 100644
--- Build.pm
+++ Build.pm
@@ -24,6 +24,8 @@ class Build is Panda::Builder {
             my $dest-dir = $dest.IO.dirname;
             mkpath $dest-dir unless $dest-dir.IO.d;

+            my $relative = $*SPEC.abs2rel($file, $workdir);
+            note "Copying $relative to $dest";
             cp($file, $dest);
         }
     }

@stmuk
Copy link
Contributor

@stmuk stmuk commented on 8249119 Oct 12, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ shoichikaji merged as 2eba7694d9
Thanks!

@skaji
Copy link

@skaji skaji commented on 8249119 Oct 12, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@stmuk thanks again!

Please sign in to comment.