Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New version, 1.3.0 #101

Merged
merged 12 commits into from
Jul 1, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
131 changes: 98 additions & 33 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,103 @@
# Change Log
# Changelog

## Version 1.2.5
## [v1.2.7](https://github.com/Raku/Documentable/tree/v1.2.7) (2020-06-27)

Fixes local configuration of JS search script.

## Version 1.2.4

Takes out Perl6 from default configuration.

## Version 1.2.3

Changes to Raku in generated pages.

## Version 1.2.2

* Actually uses local templates as indicated in the README.md

## Version 1.2.1

* Adds NEWURL for use during the transition to new Raku pages.

## [v1.0.1](https://github.com/perl6/Documentable/tree/v1.0.1) (2019-08-29)
**Implemented enhancements:**

- Strip out Perl6:: [\#11](https://github.com/perl6/Documentable/issues/11)
- Documentable start should show a progress bar or something [\#2](https://github.com/perl6/Documentable/issues/2)
- documentable should have a --version [\#1](https://github.com/perl6/Documentable/issues/1)
[Full Changelog](https://github.com/Raku/Documentable/compare/v1.2.5...v1.2.7)

**Fixed bugs:**

- CONTENT\_CLASS is not substituted in HTML [\#17](https://github.com/perl6/Documentable/issues/17)
- Terminal::Spinners is not added to dependencies [\#15](https://github.com/perl6/Documentable/issues/15)
- `documentable update` does not find new files [\#14](https://github.com/perl6/Documentable/issues/14)



\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
- Executable file "documentable" needs to respond with no args [\#94](https://github.com/Raku/Documentable/issues/94)
- Can't install Documentable because of a test failure [\#92](https://github.com/Raku/Documentable/issues/92)
- Documentable freezes on setup [\#90](https://github.com/Raku/Documentable/issues/90)
- Test 305 hangs up [\#84](https://github.com/Raku/Documentable/issues/84)
- Documentable fails with 2020.02 [\#79](https://github.com/Raku/Documentable/issues/79)

**Closed issues:**

- Include native dependencies in META6.json [\#96](https://github.com/Raku/Documentable/issues/96)
- @files check could probably be moved up [\#91](https://github.com/Raku/Documentable/issues/91)
- $c flag is not used [\#89](https://github.com/Raku/Documentable/issues/89)
- Create a function for initialization of cache [\#83](https://github.com/Raku/Documentable/issues/83)
- Add function to delete cache [\#81](https://github.com/Raku/Documentable/issues/81)
- Auto-deploy of Documentable docker container [\#75](https://github.com/Raku/Documentable/issues/75)
- Change all pointers to this new repo [\#74](https://github.com/Raku/Documentable/issues/74)
- DISTRIBUTION has disappeared, making this error with 2019.11 [\#71](https://github.com/Raku/Documentable/issues/71)
- It would be nice to read, by default, a config.json in the same directory as the documentation [\#61](https://github.com/Raku/Documentable/issues/61)
- dir "html" is present in the repo dir after installation but is not needed then [\#45](https://github.com/Raku/Documentable/issues/45)
- Add AppVeyor/Windows CI checks [\#39](https://github.com/Raku/Documentable/issues/39)
- General comments [\#37](https://github.com/Raku/Documentable/issues/37)
- missing three files with "setup" command [\#33](https://github.com/Raku/Documentable/issues/33)

**Merged pull requests:**

- Develop [\#99](https://github.com/Raku/Documentable/pull/99) ([antoniogamiz](https://github.com/antoniogamiz))
- Windows: get tests to pass [\#98](https://github.com/Raku/Documentable/pull/98) ([softmoth](https://github.com/softmoth))
- New version, 1.2.6 [\#97](https://github.com/Raku/Documentable/pull/97) ([antoniogamiz](https://github.com/antoniogamiz))
- Resolve paths before comparing them in t/100-utils.t [\#93](https://github.com/Raku/Documentable/pull/93) ([Prince213](https://github.com/Prince213))
- Ignore and remove comma config files [\#88](https://github.com/Raku/Documentable/pull/88) ([stoned](https://github.com/stoned))
- Remove verbose hanging Registry [\#86](https://github.com/Raku/Documentable/pull/86) ([tinmarino](https://github.com/tinmarino))

## [v1.2.5](https://github.com/Raku/Documentable/tree/v1.2.5) (2019-12-01)

[Full Changelog](https://github.com/Raku/Documentable/compare/v1.0.1...v1.2.5)

**Closed issues:**

- Create a string-to-kind mapping [\#69](https://github.com/Raku/Documentable/issues/69)
- Documentable::Config is not tested [\#68](https://github.com/Raku/Documentable/issues/68)
- search\_template.js of the local directory is not used [\#67](https://github.com/Raku/Documentable/issues/67)
- Tests are failing using "old" template configuration... [\#64](https://github.com/Raku/Documentable/issues/64)
- Add documentation about config file [\#60](https://github.com/Raku/Documentable/issues/60)
- Add a new NEWURL template to use for the old documentation [\#56](https://github.com/Raku/Documentable/issues/56)
- Transition to Raku [\#54](https://github.com/Raku/Documentable/issues/54)
- Local templates are not used [\#53](https://github.com/Raku/Documentable/issues/53)
- Verbose and version \(documentable -V\) does not work "correctly" [\#49](https://github.com/Raku/Documentable/issues/49)
- Adapt document URLs [\#46](https://github.com/Raku/Documentable/issues/46)
- Lots of pages don't get PODPATH substituted [\#44](https://github.com/Raku/Documentable/issues/44)
- master fails testing [\#41](https://github.com/Raku/Documentable/issues/41)
- typo in update messsage [\#38](https://github.com/Raku/Documentable/issues/38)
- Need a short version of option '--version' for 'documentable' [\#36](https://github.com/Raku/Documentable/issues/36)
- Assets are still downloaded from the old repo [\#35](https://github.com/Raku/Documentable/issues/35)
- Progress bars do no reach the end in routine and syntax files [\#30](https://github.com/Raku/Documentable/issues/30)
- Can't install module [\#29](https://github.com/Raku/Documentable/issues/29)
- Add test for documentable not changing URLs in documents [\#28](https://github.com/Raku/Documentable/issues/28)
- Inconsistent index escaping [\#26](https://github.com/Raku/Documentable/issues/26)
- IRC chat link missing [\#25](https://github.com/Raku/Documentable/issues/25)
- Some pages are regenerated always [\#24](https://github.com/Raku/Documentable/issues/24)
- Error \(possibly\) when updating homepage.pod6 [\#23](https://github.com/Raku/Documentable/issues/23)
- Make progress bars optional [\#22](https://github.com/Raku/Documentable/issues/22)
- documentable update is not working [\#20](https://github.com/Raku/Documentable/issues/20)
- type-graph.txt can't be in the main directory [\#12](https://github.com/Raku/Documentable/issues/12)

**Merged pull requests:**

- Fix primary name construction [\#59](https://github.com/Raku/Documentable/pull/59) ([stoned](https://github.com/stoned))
- Fix typos [\#58](https://github.com/Raku/Documentable/pull/58) ([stoned](https://github.com/stoned))
- Fix -a/--all option description [\#57](https://github.com/Raku/Documentable/pull/57) ([stoned](https://github.com/stoned))
- Fix verbose option in tests and -V option, fix \#49 [\#50](https://github.com/Raku/Documentable/pull/50) ([antoniogamiz](https://github.com/antoniogamiz))
- Adapt document URL, close \#46 [\#48](https://github.com/Raku/Documentable/pull/48) ([antoniogamiz](https://github.com/antoniogamiz))
- add missing doc category [\#43](https://github.com/Raku/Documentable/pull/43) ([tbrowder](https://github.com/tbrowder))
- add sort to ensure order of file names is correct [\#40](https://github.com/Raku/Documentable/pull/40) ([tbrowder](https://github.com/tbrowder))
- it's hex, not just dec [\#32](https://github.com/Raku/Documentable/pull/32) ([shintakezou](https://github.com/shintakezou))
- tweak grammar [\#31](https://github.com/Raku/Documentable/pull/31) ([tbrowder](https://github.com/tbrowder))

## [v1.0.1](https://github.com/Raku/Documentable/tree/v1.0.1) (2019-08-29)

[Full Changelog](https://github.com/Raku/Documentable/compare/v3.0.2...v1.0.1)

**Closed issues:**

- CONTENT\_CLASS is not substituted in HTML [\#17](https://github.com/Raku/Documentable/issues/17)
- Terminal::Spinners is not added to dependencies [\#15](https://github.com/Raku/Documentable/issues/15)
- `documentable update` does not find new files [\#14](https://github.com/Raku/Documentable/issues/14)
- Strip out Perl6:: [\#11](https://github.com/Raku/Documentable/issues/11)
- Documentable start should show a progress bar or something [\#2](https://github.com/Raku/Documentable/issues/2)
- documentable should have a --version [\#1](https://github.com/Raku/Documentable/issues/1)

## [v3.0.2](https://github.com/Raku/Documentable/tree/v3.0.2) (2019-08-27)

[Full Changelog](https://github.com/Raku/Documentable/compare/925a4d1a39e6cc9dc757a08d8ba891932ea99100...v3.0.2)



\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*
19 changes: 8 additions & 11 deletions META6.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "Documentable",
"description": "An API for Raku documentation",
"version": "1.2.7",
"version": "1.3.0",
"perl": "6.d",
"authors": [
"@moritz",
Expand All @@ -11,12 +11,12 @@
"@antoniogamiz",
"@JJ"
],
"auth": "github:perl6",
"auth": "github:Raku",
"depends": [
"Pod::Load:ver<0.5.4+>",
"Pod::To::HTML:ver<0.6.2+>",
"Pod::To::Cached:ver<0.3.5+>",
"Perl6::TypeGraph:ver<2.1.1+>:auth<github:antoniogamiz>:api<2>",
"Perl6::TypeGraph:ver<2.1.3+>:auth<github:antoniogamiz>:api<2>",
"Pod::Utilities:ver<0.0.1+>",
"URI:ver<0.3+>",
"File::Temp:ver<0.0.6+>",
Expand Down Expand Up @@ -54,20 +54,17 @@
"Documentable::Utils::Text": "lib/Documentable/Utils/Text.pm6"
},
"resources": [
"html/images/pencil.svg",
"template/head.html",
"template/header.html",
"template/footer.html",
"template/tg-fragment.html",
"template/search_template.js",
"templates/main.mustache",
"templates/tg-fragment.html",
"templates/search_template.js",
"config.json"
],
"license": "Artistic-2.0",
"tags": [
"documentation",
"text",
"perl6"
"raku"
],
"api": 1,
"source-url": "https://github.com/perl6/Documentable.git"
"source-url": "https://github.com/Raku/Documentable.git"
}
6 changes: 2 additions & 4 deletions docs/404.pod6
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,12 @@

<li> If you got here by following
a link on this site or as a result of searching on it, please report it
<a href="https://github.com/perl6/doc/issues/">on our GitHub repository</a>
<a href="https://github.com/Raku/doc/issues/">on our GitHub repository</a>
so we can fix it!</li>
<li>If a search engine sent you here, the link might have disappeared due to site reorganization. We still encourage you to report it as above, but it will eventually disappear from search engines too.</li>
<li>If you came following a link from some site or blog, we would still want to know about that; you might want to report the blog or website author too.</li>
</ul>

</p>

=end Html

# vim: expandtab softtabstop=4 shiftwidth=4 ft=perl6
=end Html
10 changes: 4 additions & 6 deletions docs/HomePage.pod6
Original file line number Diff line number Diff line change
@@ -1,16 +1,14 @@
=begin Html

Welcome to the documentation of the <a href="https://github.com/perl6/Documentable">Documentable</a> module.
Welcome to the documentation of the <a href="https://github.com/Raku/Documentable">Documentable</a> module.

This module provides you with an easy way to document your module and generate a site without
having to worry about HTML generation, indexing and search utilities.

I recommend you to start reading <a href="/Documentable/language.html">the language page</a> to see
I recommend you to start reading <a href="/language.html">the language page</a> to see
how to setup this module.

If you find a problem or think some aspects should be improved, please raise an
<a href="https://github.com/perl6/Documentable/issues">issue</a>.
<a href="https://github.com/Raku/Documentable/issues">issue</a>.

=end Html

# vim: expandtab softtabstop=4 shiftwidth=4 ft=perl6
=end Html
Loading