-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
15 changed files
with
1,202 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| language: python | ||
| python: | ||
| - "3.6" | ||
| install: | ||
| - wget https://github.com/jgm/pandoc/releases/download/2.8.1/pandoc-2.8.1-1-amd64.deb | ||
| - sudo dpkg -i pandoc-2.8.1-1-amd64.deb | ||
| - pandoc -v | ||
| - pip install -e .[test] | ||
| - pip install black | ||
| - pip install pylint | ||
| - pip install coverage | ||
| - pip install coveralls | ||
| script: | ||
| - black --check pandoc_beamer_arrow.py setup.py tests/test_arrow.py | ||
| - pylint pandoc_beamer_arrow.py setup.py | ||
| - coverage run -a --source=pandoc_beamer_arrow setup.py test | ||
| after_success: | ||
| - coveralls | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| BSD 3-Clause License | ||
|
|
||
| Copyright (c) 2019, Christophe Demko | ||
| All rights reserved. | ||
|
|
||
| Redistribution and use in source and binary forms, with or without | ||
| modification, are permitted provided that the following conditions are met: | ||
|
|
||
| * Redistributions of source code must retain the above copyright notice, this | ||
| list of conditions and the following disclaimer. | ||
|
|
||
| * Redistributions in binary form must reproduce the above copyright notice, | ||
| this list of conditions and the following disclaimer in the documentation | ||
| and/or other materials provided with the distribution. | ||
|
|
||
| * Neither the name of the copyright holder nor the names of its | ||
| contributors may be used to endorse or promote products derived from | ||
| this software without specific prior written permission. | ||
|
|
||
| THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" | ||
| AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
| IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | ||
| DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE | ||
| FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | ||
| DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR | ||
| SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER | ||
| CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, | ||
| OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | ||
| OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| include README.md | ||
| include LICENSE | ||
| include MANIFEST.in | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| # pandoc-beamer-arrow | ||
| [](https://travis-ci.org/chdemko/pandoc-beamer-arrow/branches) | ||
| [](https://coveralls.io/github/chdemko/pandoc-beamer-arrow?branch=0.1.0) | ||
| [](https://codeclimate.com/github/chdemko/pandoc-beamer-arrow/) | ||
| [](https://codebeat.co/projects/github-com-chdemko-pandoc-beamer-arrow-develop/) | ||
| [](https://www.codacy.com/app/chdemko/pandoc-beamer-arrow) | ||
| [](https://www.codefactor.io/repository/github/chdemko/pandoc-beamer-arrow) | ||
| [](https://pypi.org/project/pandoc-beamer-arrow/) | ||
| [](https://pypi.org/project/pandoc-beamer-arrow/) | ||
| [](https://raw.githubusercontent.com/chdemko/pandoc-beamer-arrow/0.1.0/LICENSE) | ||
| [](https://pypi.org/project/pandoc-beamer-arrow/) | ||
| [](https://pepy.tech/project/pandoc-beamer-arrow) | ||
| [](https://pypi.org/project/pandoc-beamer-arrow/) | ||
| [](http://pandoc-beamer-arrow.readthedocs.io/en/latest/) | ||
| [](https://pypi.org/project/black/) | ||
|
|
||
| *pandoc-beamer-arrow* is a [pandoc] filter for adding admonition to `div`s or `codeblock`s elements. | ||
|
|
||
| It uses the *tcolorbox* LaTeX package to generate admonitions and the *footnote* LaTeX package to handle correctly footnotes in admonition. | ||
|
|
||
| [pandoc]: http://pandoc.org/ | ||
|
|
||
| Documentation | ||
| ------------- | ||
|
|
||
| See the [Read the docs pages](http://pandoc-beamer-arrow.readthedocs.io/en/0.1.0/). | ||
|
|
||
| Usage | ||
| ----- | ||
|
|
||
| To apply the filter, use the following option with pandoc: | ||
|
|
||
| --filter pandoc-beamer-arrow | ||
|
|
||
| Installation | ||
| ------------ | ||
|
|
||
| *pandoc-beamer-arrow* requires [python 3.6], a programming language that comes pre-installed on linux and Mac OS X, and which is easily installed [on Windows]. | ||
|
|
||
| Install *pandoc-beamer-arrow* as root using the bash command | ||
|
|
||
| pip install pandoc-beamer-arrow | ||
|
|
||
| To upgrade to the most recent release, use | ||
|
|
||
| pip install --upgrade pandoc-beamer-arrow | ||
|
|
||
| To upgrade to the current code, use | ||
|
|
||
| pip install --upgrade --force git+https://github.com/chdemko/pandoc-beamer-arrow | ||
|
|
||
| `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 | ||
|
|
||
| apt-get update | ||
| apt-get install python-pip | ||
|
|
||
| Make sure you have the | ||
|
|
||
| * *xcolor* | ||
|
|
||
| LaTeX packages. On linux you have to install some extra libraries **before** *pandoc-beamer-arrow*. On a Debian-based system (including Ubuntu), you can install it as root using | ||
|
|
||
| apt-get texlive-latex-extra | ||
|
|
||
| [python 3.6]: https://www.python.org | ||
| [on Windows]: https://www.python.org/downloads/windows | ||
| [PyPI]: https://pypi.org | ||
|
|
||
|
|
||
| Getting Help | ||
| ------------ | ||
|
|
||
| If you have any difficulties with pandoc-beamer-arrow, please feel welcome to [file an issue] on github so that we can help. | ||
|
|
||
| [file an issue]: https://github.com/chdemko/pandoc-beamer-arrow/issues | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,196 @@ | ||
| # -*- coding: utf-8 -*- | ||
| # | ||
| # Configuration file for the Sphinx documentation builder. | ||
| # | ||
| # This file does only contain a selection of the most common options. For a | ||
| # full list see the documentation: | ||
| # http://www.sphinx-doc.org/en/master/config | ||
|
|
||
| # -- Path setup -------------------------------------------------------------- | ||
|
|
||
| # If extensions (or modules to document with autodoc) are in another directory, | ||
| # add these directories to sys.path here. If the directory is relative to the | ||
| # documentation root, use os.path.abspath to make it absolute, like shown here. | ||
| # | ||
| # import os | ||
| # import sys | ||
| # sys.path.insert(0, os.path.abspath('.')) | ||
|
|
||
| import os | ||
| import sys | ||
|
|
||
| sys.path.insert(0, os.path.abspath("../..")) | ||
|
|
||
| on_rtd = os.environ.get("READTHEDOCS", None) == "True" | ||
|
|
||
| # -- Project information ----------------------------------------------------- | ||
|
|
||
| project = "pandoc-beamer-arrow" | ||
| copyright = "2019, Christophe Demko" | ||
| author = "Christophe Demko" | ||
|
|
||
| # The short X.Y version | ||
| version = "0.1" | ||
| # The full version, including alpha/beta/rc tags | ||
| release = "0.1.0" | ||
|
|
||
| # -- General configuration --------------------------------------------------- | ||
|
|
||
| # If your documentation needs a minimal Sphinx version, state it here. | ||
| # | ||
| # needs_sphinx = '1.0' | ||
| needs_sphinx = "2.2" | ||
|
|
||
| # Add any Sphinx extension module names here, as strings. They can be | ||
| # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom | ||
| # ones. | ||
| extensions = [] | ||
|
|
||
| # Add any paths that contain templates here, relative to this directory. | ||
| templates_path = [] | ||
|
|
||
| # The suffix(es) of source filenames. | ||
| # You can specify multiple suffix as a list of string: | ||
| # | ||
| # source_suffix = ['.rst', '.md'] | ||
| source_suffix = ".rst" | ||
|
|
||
| # The master toctree document. | ||
| master_doc = "index" | ||
|
|
||
| # The language for content autogenerated by Sphinx. Refer to documentation | ||
| # for a list of supported languages. | ||
| # | ||
| # This is also used if you do content translation via gettext catalogs. | ||
| # Usually you set "language" from the command line for these cases. | ||
| language = None | ||
|
|
||
| # List of patterns, relative to source directory, that match files and | ||
| # directories to ignore when looking for source files. | ||
| # This pattern also affects html_static_path and html_extra_path. | ||
| exclude_patterns = [] | ||
|
|
||
| # The name of the Pygments (syntax highlighting) style to use. | ||
| # pygments_style = None | ||
| pygments_style = "sphinx" | ||
|
|
||
|
|
||
| # -- Options for HTML output ------------------------------------------------- | ||
|
|
||
| # The theme to use for HTML and HTML Help pages. See the documentation for | ||
| # a list of builtin themes. | ||
| # | ||
| if not on_rtd: # only import and set the theme if we're building docs locally | ||
| import sphinx_rtd_theme | ||
|
|
||
| html_theme = "sphinx_rtd_theme" | ||
| html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] | ||
|
|
||
| # Theme options are theme-specific and customize the look and feel of a theme | ||
| # further. For a list of options available for each theme, see the | ||
| # documentation. | ||
| # | ||
| # html_theme_options = {} | ||
|
|
||
| # Add any paths that contain custom static files (such as style sheets) here, | ||
| # relative to this directory. They are copied after the builtin static files, | ||
| # so a file named "default.css" will overwrite the builtin "default.css". | ||
| html_static_path = [] | ||
|
|
||
| # Custom sidebar templates, must be a dictionary that maps document names | ||
| # to template names. | ||
| # | ||
| # The default sidebars (for documents that don't match any pattern) are | ||
| # defined by theme itself. Builtin themes are using these templates by | ||
| # default: ``['localtoc.html', 'relations.html', 'sourcelink.html', | ||
| # 'searchbox.html']``. | ||
| # | ||
| # html_sidebars = {} | ||
|
|
||
|
|
||
| # -- Options for HTMLHelp output --------------------------------------------- | ||
|
|
||
| # Output file base name for HTML help builder. | ||
| htmlhelp_basename = "pandoc-latex-admonitiondoc" | ||
|
|
||
|
|
||
| # -- Options for LaTeX output ------------------------------------------------ | ||
|
|
||
| latex_elements = { | ||
| # The paper size ('letterpaper' or 'a4paper'). | ||
| # | ||
| # 'papersize': 'letterpaper', | ||
| # The font size ('10pt', '11pt' or '12pt'). | ||
| # | ||
| # 'pointsize': '10pt', | ||
| # Additional stuff for the LaTeX preamble. | ||
| # | ||
| # 'preamble': '', | ||
| # Latex figure (float) alignment | ||
| # | ||
| # 'figure_align': 'htbp', | ||
| } | ||
|
|
||
| # Grouping the document tree into LaTeX files. List of tuples | ||
| # (source start file, target name, title, | ||
| # author, documentclass [howto, manual, or own class]). | ||
| latex_documents = [ | ||
| ( | ||
| master_doc, | ||
| "pandoc-latex-admonition.tex", | ||
| "pandoc-latex-admonition Documentation", | ||
| "Christophe Demko", | ||
| "manual", | ||
| ) | ||
| ] | ||
|
|
||
|
|
||
| # -- Options for manual page output ------------------------------------------ | ||
|
|
||
| # One entry per manual page. List of tuples | ||
| # (source start file, name, description, authors, manual section). | ||
| man_pages = [ | ||
| ( | ||
| master_doc, | ||
| "pandoc-latex-admonition", | ||
| "pandoc-latex-admonition Documentation", | ||
| [author], | ||
| 1, | ||
| ) | ||
| ] | ||
|
|
||
|
|
||
| # -- Options for Texinfo output ---------------------------------------------- | ||
|
|
||
| # Grouping the document tree into Texinfo files. List of tuples | ||
| # (source start file, target name, title, author, | ||
| # dir menu entry, description, category) | ||
| texinfo_documents = [ | ||
| ( | ||
| master_doc, | ||
| "pandoc-latex-admonition", | ||
| "pandoc-latex-admonition Documentation", | ||
| author, | ||
| "pandoc-latex-admonition", | ||
| "One line description of project.", | ||
| "Miscellaneous", | ||
| ) | ||
| ] | ||
|
|
||
|
|
||
| # -- Options for Epub output ------------------------------------------------- | ||
|
|
||
| # Bibliographic Dublin Core info. | ||
| epub_title = project | ||
|
|
||
| # The unique identifier of the text. This can be a ISBN number | ||
| # or the project homepage. | ||
| # | ||
| # epub_identifier = '' | ||
|
|
||
| # A unique identification for the text. | ||
| # | ||
| # epub_uid = '' | ||
|
|
||
| # A list of files that should not be packed into the epub file. | ||
| epub_exclude_files = ["search.html"] |
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| [**abc**]{.beamer-arrow-node #id1} | ||
| Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer auctor blandit felis ut | ||
| elementum. Donec accumsan ex at orci volutpat iaculis. Proin in risus metus. Nunc sit amet | ||
| auctor nunc, quis consectetur turpis. Maecenas gravida blandit odio vitae dignissim. In | ||
| maximus purus quis enim molestie iaculis. Quisque ut urna nec justo dictum accumsan ut | ||
| quis odio. Sed nulla erat, posuere at sapien tempus, venenatis vulputate mi. Nam pretium | ||
| sem id enim condimentum, vel porttitor dolor viverra. Sed commodo est sit amet nisi | ||
| pharetra lacinia. Vivamus consectetur ut mauris quis posuere. Pellentesque eget ipsum et | ||
| nibh ullamcorper ullamcorper eget eu velit. | ||
| [**def**]{.beamer-arrow-node #id2 color="pink" from="2"} Pellentesque eget ipsum et nibh | ||
| ullamcorper ullamcorper eget eu velit. | ||
| [**ghi**]{.beamer-arrow-node from="2"} | ||
|
|
||
| []{.beamer-arrow-edge src="id1" dest="id2" angle_src="90" color="pink" linewidth="3" from="2"} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| .. pandoc-numbering documentation master file, created by | ||
| sphinx-quickstart on Mon Dec 17 11:33:59 2018. | ||
| You can adapt this file completely to your liking, but it should at least | ||
| contain the root `toctree` directive. | ||
| Welcome to pandoc-beamer-arrow's documentation! | ||
| =================================================== | ||
|
|
||
| Explanation | ||
| ----------- | ||
|
|
||
| *pandoc-beamer-arrow* creates arrows between text elements for beamer presentation. | ||
|
|
||
| Example | ||
| ------- | ||
|
|
||
| Demonstration: Using | ||
| :download:`pandoc-beamer-arrow-sample.txt <images/pandoc-beamer-arrow-sample.txt>` | ||
| as input gives output file in | ||
| :download:`pdf <images/pandoc-beamer-arrow-sample.pdf>`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| Sphinx>=2.2 | ||
| sphinx_rtd_theme>=0.4 | ||
|
|
Oops, something went wrong.