Skip to content

Commit 3f08953

Browse files
chdemkochdemko
committed
Merge branch 'release/1.0.0.0'
2 parents 80a4123 + a5f0a8f commit 3f08953

19 files changed

+1987
-347
lines changed

‎.github/workflows/python-package.yml

Lines changed: 98 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -10,48 +10,126 @@ on:
1010
branches: [ develop ]
1111

1212
jobs:
13-
test:
13+
python:
14+
runs-on: ubuntu-latest
15+
strategy:
16+
matrix:
17+
python-version: ["3.9", "3.10", "3.11"]
18+
poetry-version: ["1.5.1"]
19+
pandoc-version: ["3.1.3"]
20+
steps:
21+
- uses: actions/checkout@v3
22+
- name: Set up Python ${{ matrix.python-version }}
23+
uses: actions/setup-python@v4
24+
with:
25+
python-version: ${{ matrix.python-version }}
26+
- name: Set up Poetry ${{ matrix.poetry-version }}
27+
uses: abatilo/actions-poetry@v2
28+
with:
29+
poetry-version: ${{ matrix.poetry-version }}
30+
- name: Install dependencies
31+
run: |
32+
wget https://github.com/jgm/pandoc/releases/download/${{ matrix.pandoc-version }}/pandoc-${{ matrix.pandoc-version }}-1-amd64.deb
33+
sudo dpkg -i ./pandoc-${{ matrix.pandoc-version }}-1-amd64.deb
34+
poetry install
35+
- name: Test with tox
36+
run: |
37+
poetry run tox -e py
1438
39+
poetry:
1540
runs-on: ubuntu-latest
1641
strategy:
1742
matrix:
18-
python-version: [3.6, 3.7, 3.8, 3.9]
43+
python-version: ["3.11"]
44+
poetry-version: ["1.2.2", "1.3.2", "1.4.2", "1.5.1"]
45+
pandoc-version: ["3.1.3"]
46+
steps:
47+
- uses: actions/checkout@v3
48+
- name: Set up Python ${{ matrix.python-version }}
49+
uses: actions/setup-python@v4
50+
with:
51+
python-version: ${{ matrix.python-version }}
52+
- name: Set up Poetry ${{ matrix.poetry-version }}
53+
uses: abatilo/actions-poetry@v2
54+
with:
55+
poetry-version: ${{ matrix.poetry-version }}
56+
- name: Install dependencies
57+
run: |
58+
wget https://github.com/jgm/pandoc/releases/download/${{ matrix.pandoc-version }}/pandoc-${{ matrix.pandoc-version }}-1-amd64.deb
59+
sudo dpkg -i ./pandoc-${{ matrix.pandoc-version }}-1-amd64.deb
60+
poetry install
61+
- name: Test with tox
62+
run: |
63+
poetry run tox -e py
1964
65+
pandoc:
66+
runs-on: ubuntu-latest
67+
strategy:
68+
matrix:
69+
python-version: ["3.11"]
70+
poetry-version: ["1.5.1"]
71+
pandoc-version: ["2.11.4", "2.12", "2.13", "2.14.2", "2.15", "2.16.2", "2.17.1.1", "2.18", "2.19.2", "3.0.1", "3.1.3"]
2072
steps:
21-
- uses: actions/checkout@v2
73+
- uses: actions/checkout@v3
2274
- name: Set up Python ${{ matrix.python-version }}
23-
uses: actions/setup-python@v2
75+
uses: actions/setup-python@v4
2476
with:
2577
python-version: ${{ matrix.python-version }}
78+
- name: Set up Poetry ${{ matrix.poetry-version }}
79+
uses: abatilo/actions-poetry@v2
80+
with:
81+
poetry-version: ${{ matrix.poetry-version }}
2682
- name: Install dependencies
2783
run: |
28-
wget https://github.com/jgm/pandoc/releases/download/2.18/pandoc-2.18-1-amd64.deb
29-
sudo dpkg -i pandoc-2.18-1-amd64.deb
30-
python -m pip install --upgrade pip
31-
pip install tox
32-
pip install .[docs,test]
84+
wget https://github.com/jgm/pandoc/releases/download/${{ matrix.pandoc-version }}/pandoc-${{ matrix.pandoc-version }}-1-amd64.deb
85+
sudo dpkg -i ./pandoc-${{ matrix.pandoc-version }}-1-amd64.deb
86+
poetry install
3387
- name: Test with tox
3488
run: |
35-
tox -e py
89+
poetry run tox -e py
3690
37-
cov:
91+
style:
3892
runs-on: ubuntu-latest
93+
steps:
94+
- uses: actions/checkout@v3
95+
- name: Set up Python
96+
uses: actions/setup-python@v4
97+
with:
98+
python-version: '3.11'
99+
- name: Set up Poetry
100+
uses: abatilo/actions-poetry@v2
101+
with:
102+
poetry-version: '1.5.1'
103+
- name: Install dependencies
104+
run: |
105+
poetry install
106+
- name: Test with tox
107+
run: |
108+
poetry run tox -e style
109+
poetry run tox -e linter
39110
111+
cov:
112+
runs-on: ubuntu-latest
40113
steps:
41-
- uses: actions/checkout@v2
114+
- uses: actions/checkout@v3
42115
- name: Set up Python
43-
uses: actions/setup-python@v1
116+
uses: actions/setup-python@v4
44117
with:
45-
python-version: '3.x'
118+
python-version: '3.11'
119+
- name: Set up Poetry
120+
uses: abatilo/actions-poetry@v2
121+
with:
122+
poetry-version: '1.5.1'
46123
- name: Install dependencies
47124
run: |
48-
wget https://github.com/jgm/pandoc/releases/download/2.18/pandoc-2.18-1-amd64.deb
49-
sudo dpkg -i pandoc-2.18-1-amd64.deb
50-
python -m pip install --upgrade pip
51-
pip install setuptools coveralls .[test]
125+
wget https://github.com/jgm/pandoc/releases/download/3.1.3/pandoc-3.1.3-1-amd64.deb
126+
sudo dpkg -i ./pandoc-3.1.3-1-amd64.deb
127+
poetry install
52128
- name: Test
53129
env:
54130
COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
55131
run: |
56-
coverage run --source=pandoc_beamer_block -m pytest tests/
57-
coveralls
132+
poetry run tox -e coverage
133+
poetry run pip install coveralls
134+
poetry run coveralls
135+

‎.github/workflows/python-publish.yml

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,23 +9,25 @@ on:
99

1010
jobs:
1111
deploy:
12-
1312
runs-on: ubuntu-latest
14-
1513
steps:
16-
- uses: actions/checkout@v2
14+
- uses: actions/checkout@v3
1715
- name: Set up Python
18-
uses: actions/setup-python@v2
16+
uses: actions/setup-python@v4
17+
with:
18+
python-version: '3.11'
19+
- name: Set up Poetry
20+
uses: abatilo/actions-poetry@v2
1921
with:
20-
python-version: '3.x'
22+
poetry-version: '1.5.1'
2123
- name: Install dependencies
2224
run: |
23-
python -m pip install --upgrade pip
24-
pip install setuptools wheel twine
25+
poetry install
26+
poetry run pip install twine
2527
- name: Build and publish
2628
env:
2729
TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
2830
TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
2931
run: |
30-
python setup.py sdist bdist_wheel
31-
twine upload dist/*
32+
poetry build
33+
poetry run twine upload dist/*

‎.readthedocs.yml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Read the Docs configuration file for Sphinx projects
2+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
3+
4+
# Required
5+
version: 2
6+
7+
# Set the OS, Python version and other tools you might need
8+
build:
9+
os: ubuntu-22.04
10+
tools:
11+
python: "3.11"
12+
13+
# Build documentation in the "docs/" directory with Sphinx
14+
sphinx:
15+
configuration: docs/conf.py
16+
17+
# Optionally build your docs in additional formats such as PDF and ePub
18+
formats:
19+
- htmlzip
20+
21+
# Optional but recommended, declare the Python requirements required
22+
# to build your documentation
23+
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
24+
python:
25+
install:
26+
- requirements: docs/requirements.txt
27+

‎LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
BSD 3-Clause License
22

3-
Copyright (c) 2019-2021, Christophe Demko
3+
Copyright (c) 2019-2023, Christophe Demko
44
All rights reserved.
55

66
Redistribution and use in source and binary forms, with or without

‎README.md

Lines changed: 23 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
1-
# pandoc-beamer-block
2-
[![Build Status](https://img.shields.io/travis/chdemko/pandoc-beamer-block/0.2.0.svg?logo=travis)](https://travis-ci.org/chdemko/pandoc-beamer-block/branches)
3-
[![Coveralls](https://img.shields.io/coveralls/github/chdemko/pandoc-beamer-block/0.2.0.svg?logo=Codecov&logoColor=white)](https://coveralls.io/github/chdemko/pandoc-beamer-block?branch=0.2.0)
1+
# Installation
2+
![Python package](https://github.com/chdemko/pandoc-beamer-block/workflows/Python%20package/badge.svg?branch=develop)
3+
[![Coveralls](https://img.shields.io/coveralls/github/chdemko/pandoc-beamer-block/develop.svg?logo=Codecov&logoColor=white)](https://coveralls.io/github/chdemko/pandoc-beamer-block?branch=develop)
44
[![Code Climate](https://codeclimate.com/github/chdemko/pandoc-beamer-block/badges/gpa.svg)](https://codeclimate.com/github/chdemko/pandoc-beamer-block/)
55
[![Code Beat](https://codebeat.co/badges/cb5538dc-f30b-4ac4-abf6-3c213682c54d)](https://codebeat.co/projects/g.yxqyang.asia-chdemko-pandoc-beamer-block-develop/)
66
[![Codacy](https://img.shields.io/codacy/grade/af5a670790264990811713280a8f8dcf.svg?logo=codacy&logoColor=white)](https://www.codacy.com/app/chdemko/pandoc-beamer-block)
77
[![CodeFactor](https://www.codefactor.io/repository/github/chdemko/pandoc-beamer-block/badge)](https://www.codefactor.io/repository/github/chdemko/pandoc-beamer-block)
88
[![PyPI version](https://img.shields.io/pypi/v/pandoc-beamer-block.svg?logo=Python&logoColor=white)](https://pypi.org/project/pandoc-beamer-block/)
99
[![PyPI format](https://img.shields.io/pypi/format/pandoc-beamer-block.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAIAAAACACAYAAADDPmHLAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAA3XAAAN1wFCKJt4AAAAB3RJTUUH4gwPFiYw92eBNAAAAgJJREFUeNrt3T1WwkAUgNH31Br3ogWptdAlgyvQxYgHeh0LKKxI+PHAzNyvRo8xlxl5CZKllBIaax0Rr5n53tqB3Ti3k7qPiEUpZQAAggEACAYAIBgAgGAAoG8Ey9oRAHBas9oR5NgcIDOz5TN4pjnIJiJeapwTWAFGfMR2CDRlJViUUuYAtAfgOSK+Jv5N8FbddlBGav4M7+9795jHUsqqTGtdFQIAxgE0jQCAaQCaRQDAdABNIgDgMADNIQDgcAB/EHxWjwCA4wDsvvahegQAHA+gCQQAnAagegQAnA6gagQAnAdArQhcDdx//D+ZeXvg95tHxDK21wbG2mTm/SWP38Wgcz+jMj8i4ikiVhMePrv0z3vnlO1/grS+DVoBehfuVwCAABAAAkAAqLO6nwP896Tz2ucIVgBbgAAQAAJAAAgAASAABIAAEAACQAAIADXZyfcD9P55A7W/c8oKYAsQAAJAAAgAASBzgJ5eB1sBBIAAEAACQAAIAJkDTM/9AO4HEAACQAAIAAEgANTPHMD9AFYAASAABIAAEAACQP3MAWq/H6D3OYYVwBYgAASAABAAAkDmAF5HWwEEgAAQAAJAAAgAASAABIAAEAACQAAIAAEgAASAABAAAkAACAABIAAEgAAQAAJAAAgAXVWj/x+g988FtAIIAAEgAASAABAAaqhfB1BFkJjdTNQAAAAASUVORK5CYII=)](https://pypi.org/project/pandoc-beamer-block/)
10-
[![License](https://img.shields.io/pypi/l/pandoc-beamer-block.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAIAAAABmCAYAAAADI5lUAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAA3XAAAN1wFCKJt4AAAAB3RJTUUH4gwPFiQKA106BAAABUNJREFUeNrtnV2IFlUYx3/P625qbrGlpWmWdaMVKau2EmpCrSDqxRpUUkr0SYVEFyFRUXQhfUAihTdCESVpKpKQpLZBsghltn605VVKpmZgGYvmbhpPFzMbWu3LO7szO1//H+zN7sw5c57nd8685+zMeY0quLsB04FW4A7gWmAMMAyRRbqBE8BRYCfwMfCNmXlfJ1iV5LcAbwBNimuu+Q54xcw21iSAuzcA7wOLFLtCsQl4yMxO9ymAu48HtgK3Kl6F5ACw0Mx++o8AYc/fBUxWnArN98DtZtYFULngDx8o+aXgZuDdi0YAd58fDv2iPMwzs+0WTvX2qfeXjv1Ak7n7DOBLxaOU3FYhWOQR5aS1AsxWHErLnArB8q4oJ+PM3buBoRFO6gJ2K3aZpBm4PMLxPXh09ijO2cTd90RNZkVhKzcSQAIICSAkgJAAQgIICSAkgJAAQgIICSAKT91gVOLui4EVKbZzvZm9kGD7rgHmEbw9NRoYCTQCvwInCd7UaQPaep/GLZUABP+ivDHFdo5KKPHTgNeAu6jyllXIk8A5d/8QeN7MjusWkGPcfRnBs5QtNSS/l3rgQaDT3e+UAPlN/iPA2wMYQa8APnH3ZgmQv+SPBlbGUNRw4D13r5MA+WIF0R67qsZNwMMSID+9vwF4IOZin5AA+WE+8W+O0eTuN0iAfNCSs3IlQMxMSqjciRIgH0wsmgCDNQU5CKxJMXHtMXwAHAJcndD1jSu0AGbWHkcSUmZEgmVfqltA9kkySQ0SIPsMyWnZEiAm/kiw7DMSIPt0AecSKvukBMg4ZvYXcCSh4g9LgHzwVc7KzcY00N0XAM+kmLitZrYqhnLagPsTuL7PCy0AwUJHS4oCHMpwok4AnboF5ONzwJFwFIiTd6pt5y4BssebMZbVA6xOszESIDrbiW+TrDVm9rMEyNdtwIHHgPMDLOoX4KW02yMB+ifBAWCgs4qnzex3CZBfXgS+7ee568xsQxYaIQH6Pwr0ELzk8WfEU48Dy7LSDgkwMAn2Eu2dRwceNbPfJEBxeD3s1bWwzcw+zdLFD9ZK4DHiX0CJwsEkbwXuvrrGkWBl5vTVXsGxxHBaDXE76+71CV+H9gpOiRM1HHPKzM5l7cIlQDxcX8Mxo9x9uAQoJktqOKYeuE8CFO/+P5NgabgWXnX3sRKgOMmfDWyJMJsaA+xw9wkSIN+Jr7j7U+HUdmTE028Bdrv73NKsA4Q9ZUmK7Ww3s7UxtaUZeAuYMYBirgpHgg3AcjP7sdACEOyE8XjKsq8dSI8H5gLPEu+jbfcCi9x9PbDKzDqKKkBeh/rpwN0Eu4Jcl1A19cBSYKm77wXWAZvN7AcJkG7ypwBfD3K1TeHPy+7eaGbnk65QHwL7ZlKKdY8AxmsWkC5XlqF+CdA3jWWoXwL0TUPK9V8mAdLlkpTrr5cA6VInAcpNfRnqHyzLu4jvBc3+0J8NGE6lfM1nB6UWPRJWHPRImNBnACEBhAQQEkBIACEBhAQQEkBIACEBhAQQ/8bcvRsYGuGcLuLbJ0/ESzPRvtW0x9z9MDBBsSslhyoE27eIcnKsAuxUHErLFxWC15tFOdli7m7AXmCK4lEq9gFTK+Hmx88pHqVjuZkFj4SZ2TZgs2JSGjaa2WcA1vsbd28AdgGTFZ9Csx+YaWZn4IKVQDM7DSwIDxDFve8v7E3+RQKEEhwFZgGbFKvC8REwK8wx/ytA70hgZvcQbInSobjlns6w1y++sOf/k+9qZ4ZTxKlAKzCH4OvfxgLDFNdM0k2wc/lRggW+LUBHtW8l+xuWwqBw5I0ApAAAAABJRU5ErkJggg==)](https://raw.githubusercontent.com/chdemko/pandoc-beamer-block/0.2.0/LICENSE)
10+
[![License](https://img.shields.io/pypi/l/pandoc-beamer-block.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAIAAAABmCAYAAAADI5lUAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAA3XAAAN1wFCKJt4AAAAB3RJTUUH4gwPFiQKA106BAAABUNJREFUeNrtnV2IFlUYx3/P625qbrGlpWmWdaMVKau2EmpCrSDqxRpUUkr0SYVEFyFRUXQhfUAihTdCESVpKpKQpLZBsghltn605VVKpmZgGYvmbhpPFzMbWu3LO7szO1//H+zN7sw5c57nd8685+zMeY0quLsB04FW4A7gWmAMMAyRRbqBE8BRYCfwMfCNmXlfJ1iV5LcAbwBNimuu+Q54xcw21iSAuzcA7wOLFLtCsQl4yMxO9ymAu48HtgK3Kl6F5ACw0Mx++o8AYc/fBUxWnArN98DtZtYFULngDx8o+aXgZuDdi0YAd58fDv2iPMwzs+0WTvX2qfeXjv1Ak7n7DOBLxaOU3FYhWOQR5aS1AsxWHErLnArB8q4oJ+PM3buBoRFO6gJ2K3aZpBm4PMLxPXh09ijO2cTd90RNZkVhKzcSQAIICSAkgJAAQgIICSAkgJAAQgIICSAKT91gVOLui4EVKbZzvZm9kGD7rgHmEbw9NRoYCTQCvwInCd7UaQPaep/GLZUABP+ivDHFdo5KKPHTgNeAu6jyllXIk8A5d/8QeN7MjusWkGPcfRnBs5QtNSS/l3rgQaDT3e+UAPlN/iPA2wMYQa8APnH3ZgmQv+SPBlbGUNRw4D13r5MA+WIF0R67qsZNwMMSID+9vwF4IOZin5AA+WE+8W+O0eTuN0iAfNCSs3IlQMxMSqjciRIgH0wsmgCDNQU5CKxJMXHtMXwAHAJcndD1jSu0AGbWHkcSUmZEgmVfqltA9kkySQ0SIPsMyWnZEiAm/kiw7DMSIPt0AecSKvukBMg4ZvYXcCSh4g9LgHzwVc7KzcY00N0XAM+kmLitZrYqhnLagPsTuL7PCy0AwUJHS4oCHMpwok4AnboF5ONzwJFwFIiTd6pt5y4BssebMZbVA6xOszESIDrbiW+TrDVm9rMEyNdtwIHHgPMDLOoX4KW02yMB+ifBAWCgs4qnzex3CZBfXgS+7ee568xsQxYaIQH6Pwr0ELzk8WfEU48Dy7LSDgkwMAn2Eu2dRwceNbPfJEBxeD3s1bWwzcw+zdLFD9ZK4DHiX0CJwsEkbwXuvrrGkWBl5vTVXsGxxHBaDXE76+71CV+H9gpOiRM1HHPKzM5l7cIlQDxcX8Mxo9x9uAQoJktqOKYeuE8CFO/+P5NgabgWXnX3sRKgOMmfDWyJMJsaA+xw9wkSIN+Jr7j7U+HUdmTE028Bdrv73NKsA4Q9ZUmK7Ww3s7UxtaUZeAuYMYBirgpHgg3AcjP7sdACEOyE8XjKsq8dSI8H5gLPEu+jbfcCi9x9PbDKzDqKKkBeh/rpwN0Eu4Jcl1A19cBSYKm77wXWAZvN7AcJkG7ypwBfD3K1TeHPy+7eaGbnk65QHwL7ZlKKdY8AxmsWkC5XlqF+CdA3jWWoXwL0TUPK9V8mAdLlkpTrr5cA6VInAcpNfRnqHyzLu4jvBc3+0J8NGE6lfM1nB6UWPRJWHPRImNBnACEBhAQQEkBIACEBhAQQEkBIACEBhAQQ/8bcvRsYGuGcLuLbJ0/ESzPRvtW0x9z9MDBBsSslhyoE27eIcnKsAuxUHErLFxWC15tFOdli7m7AXmCK4lEq9gFTK+Hmx88pHqVjuZkFj4SZ2TZgs2JSGjaa2WcA1vsbd28AdgGTFZ9Csx+YaWZn4IKVQDM7DSwIDxDFve8v7E3+RQKEEhwFZgGbFKvC8REwK8wx/ytA70hgZvcQbInSobjlns6w1y++sOf/k+9qZ4ZTxKlAKzCH4OvfxgLDFNdM0k2wc/lRggW+LUBHtW8l+xuWwqBw5I0ApAAAAABJRU5ErkJggg==)](https://raw.githubusercontent.com/chdemko/pandoc-beamer-block/develop/LICENSE)
1111
[![Python version](https://img.shields.io/pypi/pyversions/pandoc-beamer-block.svg?logo=Python&logoColor=white)](https://pypi.org/project/pandoc-beamer-block/)
12+
[![Poetry version](https://img.shields.io/badge/poetry-1.2%20|%201.3%20|%201.4%20|%201.5-blue.svg)](https://python-poetry.org/)
13+
[![Pandoc version](https://img.shields.io/badge/pandoc-2.11%20|%202.12%20|%202.13%20|%202.14%20|%202.15%20|%202.16%20|%202.17%20|%202.18%20|%202.19%20|%203.0%20|%203.1-blue.svg)](https://pandoc.org/)
1214
[![Downloads](https://pepy.tech/badge/pandoc-beamer-block)](https://pepy.tech/project/pandoc-beamer-block)
1315
[![Development Status](https://img.shields.io/pypi/status/pandoc-beamer-block.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAIAAAACACAYAAADDPmHLAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAA3XAAAN1wFCKJt4AAAAB3RJTUUH4gwPFiUnX5lXMAAAAlBJREFUeNrt3b1qlEEUBuB3TNDCP7wDOwv/cgv+pDC3YcDe+xBFFFLoDWhhpxiD12Ch1mJsg7irjRLGYjcKEbLC92n223meMgQSzrx7Zs6wMAkAAAAAAAAAAAAAAAAAAAAw78r+H9RaLyZZT3Itydkkx5XpUH1L8iHJVpJHpZS3/yQAtdZjSe4muZXkiLrPpd0kG0lul1K+9xaA6eK/SHJFjQfhdZIbfYRg75N+z+IPytUkd3rpANM9/422P8jt4HIp5V3XDrBu8QdpKcnNPraA62o5WKt9bAHjJCfUcpDGpZRTXQNQ1fGAApVSDvPvz1qfrv+fvb9xAiAACACDVf80qrU+q7Wecwhs4BB4gM+ZXBRt6wBtOpO/uC7WARa3AyTJqJRyWgdo18xLIgEwBSAACABt3hOYAhZ7Cph9TyAAzQYgSZ4KQNsBGAlA2wFwCDQFIAAIAAKAACAACAACgAAgAAgAAoAAIAAIAIvniwC07aVvBM2wwN8I2kmyogO0Z5TkSZKVUsqnZfVou4PpAKYABAABYDHnfAFofM6feUh0D7Cw9wA7e6OeDtDwnD/rl90DNN6hdABTAAJAs5aTjJOcVIreT+H/68DXuQNsW+bB+thHAF6p42Btdp4iaq0XMnk2bkk9B2U3yaVSyvtOHWD6Fu2Geg7Ow66Ln/x+OvZokueZPBjN/NtKslZK+dHLGDh9g3YtyYNpa2F+2/79vhb/VwfYN/acz+RFytVMno/3puDh+prJ8/GbSR730fYBAAAAAAAAAAAAAAAAAACAYfkJuHbYr8dtGYwAAAAASUVORK5CYII=)](https://pypi.org/project/pandoc-beamer-block/)
1416
[![Docs](https://img.shields.io/readthedocs/pandoc-beamer-block.svg?logo=read-the-docs&logoColor=white)](http://pandoc-beamer-block.readthedocs.io/en/latest/)
@@ -18,41 +20,37 @@
1820

1921
[pandoc]: http://pandoc.org/
2022

21-
Documentation
22-
-------------
23-
24-
See the [Read the docs pages](http://pandoc-beamer-block.readthedocs.io/en/0.2.0/).
25-
26-
Usage
27-
-----
28-
29-
To apply the filter, use the following option with pandoc:
30-
31-
--filter pandoc-beamer-block
32-
33-
Installation
23+
Instructions
3424
------------
3525

36-
*pandoc-beamer-block* requires [python 3.6], a programming language that comes pre-installed on linux and Mac OS X, and which is easily installed [on Windows].
26+
*pandoc-beamer-block* requires [python], a programming language that comes pre-installed on linux and Mac OS X, and which is easily installed [on Windows].
3727

38-
Install *pandoc-beamer-block* as root using the bash command
28+
Install *pandoc-beamer-block* using the bash command
3929

40-
pip install pandoc-beamer-block
30+
~~~shell
31+
$ pip install pandoc-beamer-block
32+
~~~
4133

4234
To upgrade to the most recent release, use
4335

44-
pip install --upgrade pandoc-beamer-block
36+
~~~shell
37+
$ pip install --upgrade pandoc-beamer-block
38+
~~~
4539

4640
To upgrade to the current code, use
4741

48-
pip install --upgrade --force git+https://github.com/chdemko/pandoc-beamer-block
42+
~~~shell
43+
$ pip install --upgrade --force git+https://github.com/chdemko/pandoc-beamer-block
44+
~~~
4945

5046
`pip` is a script that downloads and installs modules from the Python Package Index, [PyPI]. It should come installed with your python distribution. If you are running linux, `pip` may be bundled separately. On a Debian-based system (including Ubuntu), you can install it as root using
5147

52-
apt-get update
53-
apt-get install python-pip
48+
~~~shell
49+
$ sudo apt-get update
50+
$ sudo apt-get install python3-pip
51+
~~~
5452

55-
[python 3.6]: https://www.python.org
53+
[python]: https://www.python.org
5654
[on Windows]: https://www.python.org/downloads/windows
5755
[PyPI]: https://pypi.org
5856

‎docs/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
```{include} ../README.md
2+
```

0 commit comments

Comments
 (0)