Skip to content

Commit

Permalink
0.2.6
Browse files Browse the repository at this point in the history
  • Loading branch information
coke committed Mar 27, 2023
1 parent c77d033 commit 78ec9ce
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 23 deletions.
2 changes: 2 additions & 0 deletions Changes
@@ -1,6 +1,8 @@
Revision history for rakudoc

{{$NEXT}}

0.2.6 2023-03-27T19:34:57-04:00
- Remove vim lines
- Update sample doc files to .rakudoc extension
- Update README
Expand Down
2 changes: 1 addition & 1 deletion META6.json
Expand Up @@ -36,5 +36,5 @@
"File::Directory::Tree",
"File::Temp:ver<0.0.8+>"
],
"version": "0.2.5"
"version": "0.2.6"
}
21 changes: 0 additions & 21 deletions README.md
Expand Up @@ -39,24 +39,3 @@ Rakudoc is Copyright (C) 2019–2021, by Joel Schüller, Tim Siegel and others.

It is free software; you can redistribute it and/or modify it under the terms of the [Artistic License 2.0](https://www.perlfoundation.org/artistic-license-20.html).

SAMPLE
======

Clone a copy of the Raku docs repo and index it.

```
$ cd ~/sandbox
$ git clone git@github.com:Raku/doc.git
$ zef install rakudoc
$ RAKUDOC=~/sandbox/doc/doc rakudoc -b
```

Now you can get documentation of types, methods, articles.

```
$ RAKUDOC=~/sandbox/doc/doc rakudoc -D Str # TITLE class Str
$ RAKUDOC=~/sandbox/doc/doc rakudoc -D Match.target # Match's target method
$ RAKUDOC=~/sandbox/doc/doc rakudoc -D math # Language/math article
```

Note that we are using the `doc` folder in the doc repo.
2 changes: 1 addition & 1 deletion lib/Rakudoc.rakumod
Expand Up @@ -15,7 +15,7 @@ my class X::Rakudoc::BadDocument is X::Rakudoc {
}
}

class Rakudoc:auth<zef:coke>:api<1>:ver<0.2.5> {
class Rakudoc:auth<zef:coke>:api<1>:ver<0.2.6> {
has @.doc-sources;
has $.data-dir;
has $!cache;
Expand Down

0 comments on commit 78ec9ce

Please sign in to comment.