Skip to content

Commit

Permalink
0.3.2
Browse files Browse the repository at this point in the history
  • Loading branch information
nichtich committed Feb 3, 2017
1 parent 844aa3e commit b8ea43d
Show file tree
Hide file tree
Showing 6 changed files with 13 additions and 15 deletions.
3 changes: 3 additions & 0 deletions Changes
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
Revision history for Pod-Pandoc

{{$NEXT}}
- Fix converting with pod2pandoc to STDOUT
- Extend module index with module descriptions
- Include all data sections as RawBlock
- Automatically publish documentation via travis-ci

0.3.1 2017-02-01 15:45:45 CET
- Add method parse_module
Expand Down
2 changes: 1 addition & 1 deletion META.json
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@
"web" : "https://github.com/nichtich/Pod-Pandoc"
}
},
"version" : "0.3.1",
"version" : "0.3.2",
"x_contributors" : [
"Jakob Voß <jakob.voss@gbv.de>"
]
Expand Down
17 changes: 6 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,14 @@ by Pandoc

# EXAMPLES

GitHub wiki and Sphinx documentation are automatically build on each commit to
the `master` branch (see script `deploy.sh`).

## GitHub wiki

The [GitHub wiki of this project](https://github.com/nichtich/Pod-Pandoc/wiki)
is automatically populated with its module documentation. The wiki is updated
on each commit to the `master` branch (see script `deploy.sh`). Wiki pages
are created with [pod2pandoc](https://metacpan.org/pod/pod2pandoc) as following:
is automatically populated with its module documentation. Wiki pages
are created with [pod2pandoc](https://metacpan.org/pod/pod2pandoc) as following (see script `update-wiki.sh`:

pod2pandoc lib/ script/ wiki/ --ext md --index Home --wiki -t markdown_github

Expand All @@ -46,21 +48,14 @@ are created with [pod2pandoc](https://metacpan.org/pod/pod2pandoc) as following:
The [Sphinx documentation generator](https://sphinx-doc.org/) recommends
documents in reStructureText format. It further requires a configuration file
`conf.py` and some links need to be adjusted because Pandoc does not support
wikilinks in rst output format:
wikilinks in rst output format (see script `update-docs.sh`:

pod2pandoc lib/ script/ docs/ --index 0 --ext rst --wiki -t rst --standalone
perl -pi -e 's/`([^`]+) <([^>]+)>`__/-e "$2.rst" ? ":doc:`$1 <$2>`" : "`$1 <$2>`__"/e' docs/*.rst
make -C docs html

The result is published automatically at [http://pod-pandoc.rtfd.io/](http://pod-pandoc.rtfd.io/).

## GitHub pages

The documentation can be published in a similar way via GitHub pages (after
enabling this feature in your repository setting):

pod2pandoc lib/ script/ docs --ext md --wiki -t markdown_github

# REQUIREMENTS

Installation of this module does not require Pandoc but it is required to make
Expand Down
2 changes: 1 addition & 1 deletion lib/App/pod2pandoc.pm
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ use strict;
use warnings;
use 5.010;

our $VERSION = '0.3.0';
our $VERSION = '0.3.2';

use Getopt::Long qw(:config pass_through);
use Pod::Usage;
Expand Down
2 changes: 1 addition & 1 deletion lib/Pod/Pandoc.pm
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ use strict;
use warnings;
require 5.010;

our $VERSION = '0.3.1';
our $VERSION = '0.3.2';

use Pod::Simple::Pandoc;
use Pod::Pandoc::Modules;
Expand Down
2 changes: 1 addition & 1 deletion lib/Pod/Simple/Pandoc.pm
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ use strict;
use warnings;
use 5.010;

our $VERSION = '0.345.0';
our $VERSION = '0.346.0';

use Pod::Simple::SimpleTree;
use Pandoc::Elements;
Expand Down

0 comments on commit b8ea43d

Please sign in to comment.