pax_global_header00006660000000000000000000000064142434213670014520gustar00rootroot0000000000000052 comment=af0bc4622007ecc62911ca5ea3dd450b5d0c7a9e pybtex-docutils-1.0.2/000077500000000000000000000000001424342136700146575ustar00rootroot00000000000000pybtex-docutils-1.0.2/.coveragerc000066400000000000000000000001671424342136700170040ustar00rootroot00000000000000[run] branch = True [report] exclude_lines = pragma: no cover if TYPE_CHECKING: raise NotImplementedError pybtex-docutils-1.0.2/.github/000077500000000000000000000000001424342136700162175ustar00rootroot00000000000000pybtex-docutils-1.0.2/.github/workflows/000077500000000000000000000000001424342136700202545ustar00rootroot00000000000000pybtex-docutils-1.0.2/.github/workflows/python-package.yml000066400000000000000000000023051424342136700237110ustar00rootroot00000000000000name: build on: push: branches: [ develop ] pull_request: branches: [ develop ] jobs: build: runs-on: ubuntu-latest strategy: fail-fast: false matrix: python-version: ['3.6', '3.7', '3.8', '3.9', '3.10', '3.11-dev'] pip-pybtex: [pybtex] include: - python-version: '3.10' pip-pybtex: "git+https://bitbucket.org/pybtex-devs/pybtex.git" steps: - uses: actions/checkout@v2 - name: Set up Python ${{ matrix.python-version }} uses: actions/setup-python@v2 with: python-version: ${{ matrix.python-version }} - name: Install dependencies run: | python -m pip install --upgrade pip python -m pip install flake8 check-manifest pytest codecov coverage mypy types-setuptools types-docutils pip install ${{ matrix.pip-pybtex }} pip install . - name: Check manifest run: | check-manifest - name: Lint with flake8 and mypy run: | flake8 . --count --select=E9,F63,F7,F82 --show-source flake8 . --count --exit-zero --max-complexity=10 mypy - name: Test with pytest run: | coverage run -m pytest codecov pybtex-docutils-1.0.2/.gitignore000066400000000000000000000001401424342136700166420ustar00rootroot00000000000000*.pyc *~ doc/_build/ .pytest_cache/ .mypy_cache/ venv/ htmlcov/ .idea/ *.egg-info/ build/ dist/ pybtex-docutils-1.0.2/CHANGELOG.rst000066400000000000000000000031771424342136700167100ustar00rootroot000000000000001.0.2 (25 May 2022) ------------------- * New ``simplebibliography`` directive, which will generate a citation for every entry in the specified bib files, intended for simple single document workflows that do not require the full power of Sphinx. * Fix deprecation warning with docutils 0.18 (see issue #21, reported by drammock). 1.0.1 (29 July 2021) -------------------- * Add py.typed so mypy finds the type annotations. * Switch to github actions for regression testing. 1.0.0 (15 January 2021) ----------------------- * Drop Python 2.7, 3.4, and 3.5 support. * Add type annotations. * Add support for sub and sup tags. 0.2.2 (9 October 2019) ---------------------- * Drop Python 3.3 support. * New footnote and footnote_reference methods for docutils footnote support. 0.2.1 (8 December 2014) ----------------------- * Add Python 3.4 support, drop Python 3.2 support. * Support more tags, also fail gracefully on unknown tags (see issue #6, reported by Jellby). * Use universal wheel for distribution. 0.2.0 (8 August 2013) --------------------- * **BACKWARD INCOMPATIBLE** The backend now renders into a list of docutils nodes instead of a single docutils node. * New :meth:`~pybtex_docutils.Backend.paragraph` method to render an entry into a single docutils paragraph. * The ```` wrapper nodes are no more, leading to much simpler generated code. * Full test coverage. * Generated citation nodes now contain text inside a paragraph. * Minimal example. 0.1.0 (7 August 2013) --------------------- * Copied the backend from pybtex. * Initial documentation. * Initial tests and travis.ci integration. pybtex-docutils-1.0.2/INSTALL.rst000066400000000000000000000017011424342136700165160ustar00rootroot00000000000000Install the module with ``pip install pybtex-docutils``, or from source using ``python setup.py install``. .. _minimal-example: Minimal Example --------------- .. code-block:: python import io import pybtex.database.input.bibtex import pybtex.plugin style = pybtex.plugin.find_plugin('pybtex.style.formatting', 'plain')() backend = pybtex.plugin.find_plugin('pybtex.backends', 'docutils')() parser = pybtex.database.input.bibtex.Parser() data = parser.parse_stream(io.StringIO(u""" @Book{1985:lindley, author = {D. Lindley}, title = {Making Decisions}, publisher = {Wiley}, year = {1985}, edition = {2nd}, } """)) for entry in style.format_entries(data.entries.values()): print(backend.paragraph(entry)) would produce: .. code-block:: xml D. Lindley. Making Decisions. Wiley, 2nd edition, 1985. pybtex-docutils-1.0.2/LICENSE.rst000066400000000000000000000021501424342136700164710ustar00rootroot00000000000000| pybtex-docutils is a docutils backend for pybtex | Copyright (c) 2013-2021 by Matthias C. M. Troffaes Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. pybtex-docutils-1.0.2/MANIFEST.in000066400000000000000000000004431424342136700164160ustar00rootroot00000000000000include VERSION include README.rst include INSTALL.rst include CHANGELOG.rst include LICENSE.rst include requirements.txt include mypy.ini include pytest.ini include .coveragerc recursive-include doc * recursive-include test * global-exclude *.pyc global-exclude .gitignore prune doc/_build pybtex-docutils-1.0.2/README.rst000066400000000000000000000061371424342136700163550ustar00rootroot00000000000000pybtex-docutils =============== |imagegithub| |imagecodecov| A docutils backend for pybtex. Overview -------- The pybtex docutils backend allows `BibTeX `_ citations to be inserted into documentation generated by `docutils `_. * Download: https://pypi.org/project/pybtex-docutils/#files * Documentation: https://pybtex-docutils.readthedocs.io/en/latest/ * Development: http://github.com/mcmtroffaes/pybtex-docutils/ .. |imagegithub| image:: https://github.com/mcmtroffaes/pybtex-docutils/actions/workflows/python-package.yml/badge.svg :target: https://github.com/mcmtroffaes/pybtex-docutils/actions/workflows/python-package.yml :alt: github-ci .. |imagecodecov| image:: https://codecov.io/gh/mcmtroffaes/pybtex-docutils/branch/develop/graph/badge.svg :target: https://app.codecov.io/gh/mcmtroffaes/pybtex-docutils :alt: codecov Installation ------------ For use with Sphinx, simply install `sphinxcontrib-bibtex `_. For use with pure docutils, install the module with ``pip install pybtex_docutils``, or from source using ``pip install -e .``. Minimal Example --------------- For use with Sphinx, refer to the `sphinxcontrib-bibtex `_ documentation. For use with pure docutils, the module exposes a new ``simplebibliography`` directive, which will generate a citation for every entry in the specified bib files. This new directive is only intended for simple single document workflows that do not require the full power of Sphinx. You need exactly one of these directives in your document, placed at the location where you want the citations to appear (typically, at the end). For example: .. code-block:: rest See [Nelson1987]_ for an introduction to non-standard analysis. .. simplebibliography:: refs.bib where ``refs.bib`` might contain: .. code-block:: @Book{Nelson1987, author = {Edward Nelson}, title = {Radically Elementary Probability Theory}, publisher = {Princeton University Press}, year = {1987} } Note that citation keys are used as labels. For this to work, it is thus necessary that all keys in your bib file are valid citation labels for docutils. In particular, they cannot contain colons. This limitation is lifted in ``sphinxcontrib-bibtex``, which also provides many more citation features. To use the directive, you have to write your own command script (there seems to be no other way currently to extend docutils). For instance: .. code-block:: python #!/usr/bin/env python3 from docutils.parsers.rst import directives, Directive from docutils.core import publish_cmdline, default_description from pybtex_docutils import SimpleBibliography description = ('Like rst2html5.py, but with .. simplebibliography support' + default_description) if __name__ == '__main__': directives.register_directive("simplebibliography", SimpleBibliography) publish_cmdline(writer_name='html5', description=description) You can then run this command as if you would run ``rst2html5``. pybtex-docutils-1.0.2/VERSION000066400000000000000000000000061424342136700157230ustar00rootroot000000000000001.0.2 pybtex-docutils-1.0.2/doc/000077500000000000000000000000001424342136700154245ustar00rootroot00000000000000pybtex-docutils-1.0.2/doc/Makefile000066400000000000000000000127401424342136700170700ustar00rootroot00000000000000# Makefile for Sphinx documentation # # You can set these variables from the command line. SPHINXOPTS = SPHINXBUILD = sphinx-build PAPER = BUILDDIR = _build # Internal variables. PAPEROPT_a4 = -D latex_paper_size=a4 PAPEROPT_letter = -D latex_paper_size=letter ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . # the i18n builder cannot share the environment and doctrees with the others I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext help: @echo "Please use \`make ' where is one of" @echo " html to make standalone HTML files" @echo " dirhtml to make HTML files named index.html in directories" @echo " singlehtml to make a single large HTML file" @echo " pickle to make pickle files" @echo " json to make JSON files" @echo " htmlhelp to make HTML files and a HTML help project" @echo " qthelp to make HTML files and a qthelp project" @echo " devhelp to make HTML files and a Devhelp project" @echo " epub to make an epub" @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" @echo " latexpdf to make LaTeX files and run them through pdflatex" @echo " text to make text files" @echo " man to make manual pages" @echo " texinfo to make Texinfo files" @echo " info to make Texinfo files and run them through makeinfo" @echo " gettext to make PO message catalogs" @echo " changes to make an overview of all changed/added/deprecated items" @echo " linkcheck to check all external links for integrity" @echo " doctest to run all doctests embedded in the documentation (if enabled)" clean: -rm -rf $(BUILDDIR)/* html: $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." dirhtml: $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." singlehtml: $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml @echo @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." pickle: $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle @echo @echo "Build finished; now you can process the pickle files." json: $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json @echo @echo "Build finished; now you can process the JSON files." htmlhelp: $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp @echo @echo "Build finished; now you can run HTML Help Workshop with the" \ ".hhp project file in $(BUILDDIR)/htmlhelp." qthelp: $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp @echo @echo "Build finished; now you can run "qcollectiongenerator" with the" \ ".qhcp project file in $(BUILDDIR)/qthelp, like this:" @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/pybtex-docutils.qhcp" @echo "To view the help file:" @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/pybtex-docutils.qhc" devhelp: $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp @echo @echo "Build finished." @echo "To view the help file:" @echo "# mkdir -p $$HOME/.local/share/devhelp/pybtex-docutils" @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/pybtex-docutils" @echo "# devhelp" epub: $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub @echo @echo "Build finished. The epub file is in $(BUILDDIR)/epub." latex: $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." @echo "Run \`make' in that directory to run these through (pdf)latex" \ "(use \`make latexpdf' here to do that automatically)." latexpdf: $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo "Running LaTeX files through pdflatex..." $(MAKE) -C $(BUILDDIR)/latex all-pdf @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." text: $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text @echo @echo "Build finished. The text files are in $(BUILDDIR)/text." man: $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man @echo @echo "Build finished. The manual pages are in $(BUILDDIR)/man." texinfo: $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo @echo @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." @echo "Run \`make' in that directory to run these through makeinfo" \ "(use \`make info' here to do that automatically)." info: $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo @echo "Running Texinfo files through makeinfo..." make -C $(BUILDDIR)/texinfo info @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." gettext: $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale @echo @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." changes: $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes @echo @echo "The overview file is in $(BUILDDIR)/changes." linkcheck: $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck @echo @echo "Link check complete; look for any errors in the above output " \ "or in $(BUILDDIR)/linkcheck/output.txt." doctest: $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest @echo "Testing of doctests in the sources finished, look at the " \ "results in $(BUILDDIR)/doctest/output.txt." pybtex-docutils-1.0.2/doc/_static/000077500000000000000000000000001424342136700170525ustar00rootroot00000000000000pybtex-docutils-1.0.2/doc/_static/.gitignore000066400000000000000000000000001424342136700210300ustar00rootroot00000000000000pybtex-docutils-1.0.2/doc/api.rst000066400000000000000000000000401424342136700167210ustar00rootroot00000000000000.. automodule:: pybtex_docutils pybtex-docutils-1.0.2/doc/changes.rst000066400000000000000000000000761424342136700175710ustar00rootroot00000000000000:tocdepth: 1 Changes ======= .. include:: ../CHANGELOG.rst pybtex-docutils-1.0.2/doc/conf.py000066400000000000000000000173761424342136700167410ustar00rootroot00000000000000# pybtex-docutils documentation build configuration file, created by # sphinx-quickstart on Wed Aug 7 11:36:09 2013. # # This file is execfile()d with the current directory set to its containing # dir. # # Note that not all possible configuration values are present in this # autogenerated file. # # All configuration values have a default; values that are commented out # serve to show the default. # -- General configuration ----------------------------------------------- # If your documentation needs a minimal Sphinx version, state it here. # needs_sphinx = '1.0' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.coverage', 'sphinx.ext.viewcode'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] # The suffix of source filenames. source_suffix = '.rst' # The encoding of source files. # source_encoding = 'utf-8-sig' # The master toctree document. master_doc = 'index' # General information about the project. project = 'pybtex-docutils' copyright = '2013-2021, Matthias C. M. Troffaes' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The full version, including alpha/beta/rc tags. with open("../VERSION") as version_file: release = version_file.read().strip() # The short X.Y version. version = '.'.join(release.split('.')[:2]) # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # language = None # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: # today = '' # Else, today_fmt is used as the format for a strftime call. # today_fmt = '%B %d, %Y' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. exclude_patterns = ['_build'] # The reST default role (used for this markup: `text`) to use for all # documents. # default_role = None # If true, '()' will be appended to :func: etc. cross-reference text. # add_function_parentheses = True # If true, the current module name will be prepended to all description # unit titles (such as .. function::). # add_module_names = True # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. # show_authors = False # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' # A list of ignored prefixes for module index sorting. # modindex_common_prefix = [] # -- Options for HTML output --------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. html_theme = 'default' # 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 themes here, relative to this directory. # html_theme_path = [] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". # html_title = None # A shorter title for the navigation bar. Default is the same as html_title. # html_short_title = None # The name of an image file (relative to this directory) to place at the top # of the sidebar. # html_logo = None # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. # html_favicon = None # 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 = ['_static'] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. # html_last_updated_fmt = '%b %d, %Y' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. # html_use_smartypants = True # Custom sidebar templates, maps document names to template names. # html_sidebars = {} # Additional templates that should be rendered to pages, maps page names to # template names. # html_additional_pages = {} # If false, no module index is generated. # html_domain_indices = True # If false, no index is generated. # html_use_index = True # If true, the index is split into individual pages for each letter. # html_split_index = False # If true, links to the reST sources are added to the pages. # html_show_sourcelink = True # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. # html_show_sphinx = True # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. # html_show_copyright = True # If true, an OpenSearch description file will be output, and all pages will # contain a tag referring to it. The value of this option must be the # base URL from which the finished HTML is served. # html_use_opensearch = '' # This is the file name suffix for HTML files (e.g. ".xhtml"). # html_file_suffix = None # Output file base name for HTML help builder. htmlhelp_basename = 'pybtex-docutilsdoc' # -- 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': '', } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass # [howto/manual]). latex_documents = [ ('index', 'pybtex-docutils.tex', 'pybtex-docutils Documentation', 'Matthias C. M. Troffaes', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of # the title page. # latex_logo = None # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. # latex_use_parts = False # If true, show page references after internal links. # latex_show_pagerefs = False # If true, show URL addresses after external links. # latex_show_urls = False # Documents to append as an appendix to all manuals. # latex_appendices = [] # If false, no module index is generated. # latex_domain_indices = True # -- Options for manual page output -------------------------------------- # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ ('index', 'pybtex-docutils', 'pybtex-docutils Documentation', ['Matthias C. M. Troffaes'], 1) ] # If true, show URL addresses after external links. # man_show_urls = False # -- 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 = [ ('index', 'pybtex-docutils', 'pybtex-docutils Documentation', 'Matthias C. M. Troffaes', 'pybtex-docutils', 'One line description of project.', 'Miscellaneous'), ] # Documents to append as an appendix to all manuals. # texinfo_appendices = [] # If false, no module index is generated. # texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. # texinfo_show_urls = 'footnote' # Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = { 'python': ('http://docs.python.org/', None), } pybtex-docutils-1.0.2/doc/index.rst000066400000000000000000000004721424342136700172700ustar00rootroot00000000000000Welcome to pybtex-docutils's documentation! =========================================== :Release: |release| :Date: |today| Contents -------- .. toctree:: :maxdepth: 2 quickstart api changes license Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search` pybtex-docutils-1.0.2/doc/license.rst000066400000000000000000000000561424342136700176010ustar00rootroot00000000000000License ======= .. include:: ../LICENSE.rst pybtex-docutils-1.0.2/doc/make.bat000066400000000000000000000117721424342136700170410ustar00rootroot00000000000000@ECHO OFF REM Command file for Sphinx documentation if "%SPHINXBUILD%" == "" ( set SPHINXBUILD=sphinx-build ) set BUILDDIR=_build set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . set I18NSPHINXOPTS=%SPHINXOPTS% . if NOT "%PAPER%" == "" ( set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS% ) if "%1" == "" goto help if "%1" == "help" ( :help echo.Please use `make ^` where ^ is one of echo. html to make standalone HTML files echo. dirhtml to make HTML files named index.html in directories echo. singlehtml to make a single large HTML file echo. pickle to make pickle files echo. json to make JSON files echo. htmlhelp to make HTML files and a HTML help project echo. qthelp to make HTML files and a qthelp project echo. devhelp to make HTML files and a Devhelp project echo. epub to make an epub echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter echo. text to make text files echo. man to make manual pages echo. texinfo to make Texinfo files echo. gettext to make PO message catalogs echo. changes to make an overview over all changed/added/deprecated items echo. linkcheck to check all external links for integrity echo. doctest to run all doctests embedded in the documentation if enabled goto end ) if "%1" == "clean" ( for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i del /q /s %BUILDDIR%\* goto end ) if "%1" == "html" ( %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html if errorlevel 1 exit /b 1 echo. echo.Build finished. The HTML pages are in %BUILDDIR%/html. goto end ) if "%1" == "dirhtml" ( %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml if errorlevel 1 exit /b 1 echo. echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. goto end ) if "%1" == "singlehtml" ( %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml if errorlevel 1 exit /b 1 echo. echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. goto end ) if "%1" == "pickle" ( %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle if errorlevel 1 exit /b 1 echo. echo.Build finished; now you can process the pickle files. goto end ) if "%1" == "json" ( %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json if errorlevel 1 exit /b 1 echo. echo.Build finished; now you can process the JSON files. goto end ) if "%1" == "htmlhelp" ( %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp if errorlevel 1 exit /b 1 echo. echo.Build finished; now you can run HTML Help Workshop with the ^ .hhp project file in %BUILDDIR%/htmlhelp. goto end ) if "%1" == "qthelp" ( %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp if errorlevel 1 exit /b 1 echo. echo.Build finished; now you can run "qcollectiongenerator" with the ^ .qhcp project file in %BUILDDIR%/qthelp, like this: echo.^> qcollectiongenerator %BUILDDIR%\qthelp\pybtex-docutils.qhcp echo.To view the help file: echo.^> assistant -collectionFile %BUILDDIR%\qthelp\pybtex-docutils.ghc goto end ) if "%1" == "devhelp" ( %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp if errorlevel 1 exit /b 1 echo. echo.Build finished. goto end ) if "%1" == "epub" ( %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub if errorlevel 1 exit /b 1 echo. echo.Build finished. The epub file is in %BUILDDIR%/epub. goto end ) if "%1" == "latex" ( %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex if errorlevel 1 exit /b 1 echo. echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. goto end ) if "%1" == "text" ( %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text if errorlevel 1 exit /b 1 echo. echo.Build finished. The text files are in %BUILDDIR%/text. goto end ) if "%1" == "man" ( %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man if errorlevel 1 exit /b 1 echo. echo.Build finished. The manual pages are in %BUILDDIR%/man. goto end ) if "%1" == "texinfo" ( %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo if errorlevel 1 exit /b 1 echo. echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo. goto end ) if "%1" == "gettext" ( %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale if errorlevel 1 exit /b 1 echo. echo.Build finished. The message catalogs are in %BUILDDIR%/locale. goto end ) if "%1" == "changes" ( %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes if errorlevel 1 exit /b 1 echo. echo.The overview file is in %BUILDDIR%/changes. goto end ) if "%1" == "linkcheck" ( %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck if errorlevel 1 exit /b 1 echo. echo.Link check complete; look for any errors in the above output ^ or in %BUILDDIR%/linkcheck/output.txt. goto end ) if "%1" == "doctest" ( %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest if errorlevel 1 exit /b 1 echo. echo.Testing of doctests in the sources finished, look at the ^ results in %BUILDDIR%/doctest/output.txt. goto end ) :end pybtex-docutils-1.0.2/doc/quickstart.rst000066400000000000000000000002071424342136700203470ustar00rootroot00000000000000Getting Started =============== Overview -------- .. include:: ../README.rst Installation ------------ .. include:: ../INSTALL.rst pybtex-docutils-1.0.2/mypy.ini000066400000000000000000000003411424342136700163540ustar00rootroot00000000000000[mypy] files = src/pybtex_docutils/*.py,test/*.py,setup.py [mypy-pybtex.*] ignore_missing_imports = True [mypy-setuptools] ignore_missing_imports = True [mypy-docutils.parsers.rst.directives] ignore_missing_imports = True pybtex-docutils-1.0.2/pytest.ini000066400000000000000000000002201424342136700167020ustar00rootroot00000000000000[pytest] testpaths = test markers = plugin: tests for the plugin system, requires package to be installed (deselect with '-m "not plugin"') pybtex-docutils-1.0.2/requirements.txt000066400000000000000000000000331424342136700201370ustar00rootroot00000000000000docutils>=0.8 pybtex>=0.16 pybtex-docutils-1.0.2/setup.py000066400000000000000000000032341424342136700163730ustar00rootroot00000000000000from setuptools import setup import io def readfile(filename): with io.open(filename, encoding="utf-8") as stream: return stream.read().split("\n") doclines = readfile("README.rst")[5:] # skip title and badges requires = readfile("requirements.txt") version = readfile("VERSION")[0].strip() setup( name='pybtex-docutils', version=version, url='https://github.com/mcmtroffaes/pybtex-docutils', download_url='http://pypi.python.org/pypi/pybtex-docutils', license='MIT', author='Matthias C. M. Troffaes', author_email='matthias.troffaes@gmail.com', description=doclines[0], long_description="\n".join(doclines[2:]), zip_safe=False, classifiers=[ 'Development Status :: 5 - Production/Stable', 'Environment :: Console', 'Intended Audience :: Developers', 'License :: OSI Approved :: MIT License', 'Operating System :: OS Independent', 'Programming Language :: Python', 'Programming Language :: Python :: 3', 'Programming Language :: Python :: 3.6', 'Programming Language :: Python :: 3.7', 'Programming Language :: Python :: 3.8', 'Programming Language :: Python :: 3.9', 'Programming Language :: Python :: 3.10', 'Topic :: Text Editors :: Text Processing', 'Topic :: Text Processing :: Markup :: XML' ], platforms='any', packages=['pybtex_docutils'], package_dir={'': 'src'}, package_data={'pybtex_docutils': ['py.typed']}, install_requires=requires, entry_points={ 'pybtex.backends': [ 'docutils = pybtex_docutils:Backend', ] }, python_requires='>=3.6', ) pybtex-docutils-1.0.2/src/000077500000000000000000000000001424342136700154465ustar00rootroot00000000000000pybtex-docutils-1.0.2/src/pybtex_docutils/000077500000000000000000000000001424342136700206675ustar00rootroot00000000000000pybtex-docutils-1.0.2/src/pybtex_docutils/__init__.py000066400000000000000000000173521424342136700230100ustar00rootroot00000000000000""" API ~~~ The backend renders :class:`pybtex.richtext.Text` instances into a list of :class:`docutils.nodes.Node` instances. For typical use cases, all you need to care about are the methods :meth:`Backend.paragraph`, :meth:`Backend.citation`, and :meth:`Backend.citation_reference` which are to be called on *formatted* entries, as in the :ref:`minimal example `. Unless you are subclassing :class:`Backend` to create a new backend, you should normally not import the :mod:`pybtex_docutils` module directly. Instead, use pybtex's plugin system to get the :class:`Backend` class, as in the :ref:`minimal example `. .. autoclass:: Backend :show-inheritance: :members: RenderType, paragraph, citation, citation_reference, footnote, footnote_reference .. autoclass:: SimpleBibliography :show-inheritance: :members: run """ import docutils.nodes import itertools import docutils.parsers.rst.directives as directives from docutils.parsers.rst import Directive from pybtex.backends import BaseBackend import pybtex.database import pybtex.plugin import os.path from typing import TYPE_CHECKING, List, Type from pybtex.database.input.bibtex import Parser if TYPE_CHECKING: from pybtex.style import FormattedEntry class Backend(BaseBackend): name = 'docutils' symbols = { 'ndash': [docutils.nodes.Text('\u2013')], 'newblock': [docutils.nodes.Text(' ')], 'nbsp': [docutils.nodes.Text('\u00a0')], } tags = { 'emph': docutils.nodes.emphasis, # note: deprecated 'em': docutils.nodes.emphasis, 'strong': docutils.nodes.strong, 'i': docutils.nodes.emphasis, 'b': docutils.nodes.strong, 'tt': docutils.nodes.literal, 'sup': docutils.nodes.superscript, 'sub': docutils.nodes.subscript, } RenderType: Type[List[docutils.nodes.Node]] = list # for compatibility only def format_text(self, text: str) -> List[docutils.nodes.Node]: return self.format_str(text) def format_str(self, str_: str) -> List[docutils.nodes.Node]: return [docutils.nodes.Text(str_)] def format_tag(self, tag_name: str, text: List[docutils.nodes.Node] ) -> List[docutils.nodes.Node]: if tag_name in self.tags: tag = self.tags[tag_name] return [tag('', '', *text)] else: return text def format_href(self, url: str, text: List[docutils.nodes.Node], external: bool = False) -> List[docutils.nodes.Node]: node = docutils.nodes.reference('', '', *text, refuri=url) return [node] def write_entry(self, key: str, label: str, text: str) -> None: raise NotImplementedError("use Backend.citation() instead") def render_sequence(self, rendered_list: List[List[docutils.nodes.Node]] ) -> List[docutils.nodes.Node]: return list(itertools.chain(*rendered_list)) def paragraph(self, entry: "FormattedEntry") -> docutils.nodes.paragraph: """Return a docutils.nodes.paragraph containing the rendered text for *entry* (without label). .. versionadded:: 0.2.0 """ return docutils.nodes.paragraph('', '', *entry.text.render(self)) def citation(self, entry: "FormattedEntry", document: docutils.nodes.document, use_key_as_label=True ) -> docutils.nodes.citation: """Return citation node, with key as name, label as first child, and paragraph with entry text as second child. The citation is expected to be inserted into *document* prior to any docutils transforms. """ # see docutils.parsers.rst.states.Body.citation() if use_key_as_label: label = entry.key else: label = entry.label name = docutils.nodes.fully_normalize_name(entry.key) citation = docutils.nodes.citation() citation['names'].append(name) citation += docutils.nodes.label('', label) citation += self.paragraph(entry) document.note_citation(citation) document.note_explicit_target(citation, citation) return citation def citation_reference( self, entry: "FormattedEntry", document: docutils.nodes.document, use_key_as_label=True ) -> docutils.nodes.citation_reference: """Return citation_reference node to the given citation. The citation_reference is expected to be inserted into *document* prior to any docutils transforms. """ # see docutils.parsers.rst.states.Body.footnote_reference() if use_key_as_label: label = entry.key else: label = entry.label refname = docutils.nodes.fully_normalize_name(entry.key) refnode = docutils.nodes.citation_reference( '[%s]_' % label, refname=refname) refnode += docutils.nodes.Text(label) document.note_citation_ref(refnode) return refnode def footnote(self, entry: "FormattedEntry", document: docutils.nodes.document) -> docutils.nodes.footnote: """Return footnote node, with key as name, and paragraph with entry text as child. The footnote is expected to be inserted into *document* prior to any docutils transforms. .. versionadded:: 0.2.2 """ # see docutils.parsers.rst.states.Body.footnote() name = docutils.nodes.fully_normalize_name(entry.key) footnote = docutils.nodes.footnote(auto=1) footnote['names'].append(name) footnote += self.paragraph(entry) document.note_autofootnote(footnote) document.note_explicit_target(footnote, footnote) return footnote def footnote_reference(self, entry: "FormattedEntry", document: docutils.nodes.document ) -> docutils.nodes.footnote_reference: """Return footnote_reference node to the given citation. The footnote_reference is expected to be inserted into *document* prior to any docutils transforms. .. versionadded:: 0.2.2 """ # see docutils.parsers.rst.states.Body.footnote_reference() refname = docutils.nodes.fully_normalize_name(entry.key) refnode = docutils.nodes.footnote_reference( '[#%s]_' % entry.key, refname=refname, auto=1) document.note_autofootnote_ref(refnode) document.note_footnote_ref(refnode) return refnode class SimpleBibliography(Directive): name = "simplebibliography" required_arguments = 1 optional_arguments = 0 final_argument_whitespace = True has_content = False option_spec = { 'encoding': directives.unchanged, 'style': directives.unchanged, } def run(self): parser = Parser(self.options.get("encoding", "utf-8-sig")) for filename_raw in self.arguments[0].split(): filename = os.path.join( os.path.dirname(self.state_machine.document['source']), filename_raw) if not os.path.isfile(filename): raise self.error(f"could not open bibtex file {filename}") else: try: parser.parse_file(filename) except pybtex.database.BibliographyDataError as exc: raise self.error( f"bibliography data error in {filename}: {exc}") style = pybtex.plugin.find_plugin( "pybtex.style.formatting", self.options.get("style", "unsrt"))() backend = Backend() document = self.state_machine.document return [ backend.citation(style.format_entry(entry.key, entry), document) for entry in style.sort(parser.data.entries.values())] pybtex-docutils-1.0.2/src/pybtex_docutils/py.typed000066400000000000000000000000001424342136700223540ustar00rootroot00000000000000pybtex-docutils-1.0.2/test/000077500000000000000000000000001424342136700156365ustar00rootroot00000000000000pybtex-docutils-1.0.2/test/conftest.py000066400000000000000000000002461424342136700200370ustar00rootroot00000000000000import pytest from pathlib import Path collect_ignore = ['roots'] @pytest.fixture def test_roots() -> Path: return Path(__file__).parent.absolute() / 'roots' pybtex-docutils-1.0.2/test/roots/000077500000000000000000000000001424342136700170045ustar00rootroot00000000000000pybtex-docutils-1.0.2/test/roots/test_simplebibliography/000077500000000000000000000000001424342136700237305ustar00rootroot00000000000000pybtex-docutils-1.0.2/test/roots/test_simplebibliography/index.rst000066400000000000000000000001021424342136700255620ustar00rootroot00000000000000See [Mandel2009]_ and [Evensen2003]_. .. bibliography:: refs.bib pybtex-docutils-1.0.2/test/roots/test_simplebibliography/refs.bib000066400000000000000000000021611424342136700253450ustar00rootroot00000000000000@Misc{Mandel2009, author = {Jan Mandel}, title = {A Brief Tutorial on the Ensemble {K}alman Filter}, howpublished = {arXiv:0901.3725v1 [physics.ao-ph]}, month = jan, year = {2009}, OPTnote = {}, OPTannote = {}, archivePrefix = {arXiv}, eprint = {0901.3725}, primaryClass = {physics.ao-ph} } @Article{Evensen2003, author = {Geir Evensen}, title = {The Ensemble {K}alman Filter: theoretical formulation and practical implementation}, journal = {Ocean Dynamics}, year = {2003}, OPTkey = {}, volume = {53}, number = {4}, pages = {343-367}, OPTmonth = {}, OPTnote = {}, OPTannote = {}, doi = {10.1007/s10236-003-0036-9} } @Article{Lorenc1986, author = {Andrew C. Lorenc}, title = {Analysis methods for numerical weather prediction}, journal = {Quarterly Journal of the Royal Meteorological Society}, year = {1986}, OPTkey = {}, volume = {112}, number = {474}, pages = {1177-1194}, OPTmonth = {}, OPTnote = {}, OPTannote = {}, doi = {10.1002/qj.49711247414} } pybtex-docutils-1.0.2/test/test_backend.py000066400000000000000000000122751424342136700206450ustar00rootroot00000000000000import docutils.nodes import docutils.utils import pytest import pybtex.plugin import pybtex.database from pybtex.richtext import HRef, Tag, Text from pybtex_docutils import Backend def render_str(richtext): return "".join(str(node) for node in richtext.render(Backend())) # may remove this test when new pybtex is out def test_text(): assert Backend().format_text('hi') == Backend().format_str('hi') def test_tag(): tag = Tag('em', 'hello') assert render_str(tag) == 'hello' def test_tag_text(): tag = Tag('em', Text('hello', ' world')) assert render_str(tag) == 'hello world' def test_tag_strong(): tag = Tag('strong', 'hello') assert render_str(tag) == 'hello' def test_tag_i(): tag = Tag('i', 'hello') assert render_str(tag) == 'hello' def test_tag_b(): tag = Tag('b', 'hello') assert render_str(tag) == 'hello' def test_tag_tt(): tag = Tag('tt', 'hello') assert render_str(tag) == 'hello' def test_tag_sup(): tag = Tag('sup', 'hello') assert render_str(tag) == 'hello' def test_tag_sub(): tag = Tag('sub', 'hello') assert render_str(tag) == 'hello' def test_tag_unknown(): tag = Tag('***unknown***', 'hello') assert render_str(tag) == 'hello' def test_href(): href = HRef('http://www.example.com', 'hyperlinked text') assert render_str(href) == ( '' 'hyperlinked text' '') def test_href_text(): href = HRef('http://www.example.com', Text('hyperlinked', ' text')) assert render_str(href) == ( '' 'hyperlinked text' '') def test_render_sequence(): text = Text('hello ', Tag('em', 'world')) assert render_str(text) == 'hello world' @pytest.fixture def entry(): data = pybtex.database.BibliographyData({ 'hongquin1997': pybtex.database.Entry( 'article', fields={ 'language': 'english', 'title': 'Predicting the Diffusion Coefficient' ' in Supercritical Fluids', 'journal': 'Ind. Eng. Chem. Res.', 'volume': '36', 'year': '1997', 'pages': '888-895', }, persons={'author': [ pybtex.database.Person('Liu, Hongquin'), pybtex.database.Person('Ruckenstein, Eli')]}, )}) style = pybtex.plugin.find_plugin('pybtex.style.formatting', 'plain')() entries = list(style.format_entries(data.entries.values())) return entries[0] @pytest.fixture def document(): return docutils.utils.new_document('test.rst') def test_citation(entry, document): node = Backend().citation(entry, document) assert str(node) == ( '' '' '' 'Hongquin Liu and Eli Ruckenstein. ' 'Predicting the diffusion coefficient in supercritical fluids. ' 'Ind. Eng. Chem. Res., ' '36:888–895, 1997.' '' '') def test_citation_reference(entry, document): node = Backend().citation_reference(entry, document) assert str(node) == ( '' 'hongquin1997' '') def test_citation_use_label(entry, document): node = Backend().citation( entry, document, use_key_as_label=False) assert str(node) == ( '' '' '' 'Hongquin Liu and Eli Ruckenstein. ' 'Predicting the diffusion coefficient in supercritical fluids. ' 'Ind. Eng. Chem. Res., ' '36:888–895, 1997.' '' '') def test_citation_reference_use_label(entry, document): node = Backend().citation_reference( entry, document, use_key_as_label=False) assert str(node) == ( '' '1' '') def test_footnote(entry, document): node = Backend().footnote(entry, document) assert str(node) == ( '' '' 'Hongquin Liu and Eli Ruckenstein. ' 'Predicting the diffusion coefficient in supercritical fluids. ' 'Ind. Eng. Chem. Res., ' '36:888–895, 1997.' '' '') def test_footnote_reference(entry, document): node = Backend().footnote_reference(entry, document) assert str(node) == ( '') def test_write_entry(): with pytest.raises(NotImplementedError): Backend().write_entry(None, None, None) pybtex-docutils-1.0.2/test/test_find_plugin.py000066400000000000000000000010321424342136700215410ustar00rootroot00000000000000# note: tests require pybtex-docutils to be installed # so its entry points can be found import pytest import pybtex_docutils @pytest.mark.plugin def test_pkg_resources_entry_point(): from pkg_resources import iter_entry_points for ep in iter_entry_points("pybtex.backends", "docutils"): assert ep.load() is pybtex_docutils.Backend @pytest.mark.plugin def test_pybtex_find_plugin(): from pybtex.plugin import find_plugin assert ( find_plugin("pybtex.backends", "docutils") is pybtex_docutils.Backend) pybtex-docutils-1.0.2/test/test_install_example.py000066400000000000000000000017071424342136700224350ustar00rootroot00000000000000expected_result = ( 'D.\xa0Lindley. Making Decisions. ' 'Wiley, 2nd edition, 1985.' ) def test_install_example(): result = [] # example begin import io import pybtex.database.input.bibtex import pybtex.plugin style = pybtex.plugin.find_plugin('pybtex.style.formatting', 'plain')() backend = pybtex.plugin.find_plugin('pybtex.backends', 'docutils')() parser = pybtex.database.input.bibtex.Parser() data = parser.parse_stream(io.StringIO(u""" @Book{1985:lindley, author = {D. Lindley}, title = {Making Decisions}, publisher = {Wiley}, year = {1985}, edition = {2nd}, } """)) for entry in style.format_entries(data.entries.values()): print(backend.paragraph(entry)) # example end result.append(backend.paragraph(entry)) assert len(result) == 1 assert str(result[0]) == expected_result pybtex-docutils-1.0.2/test/test_simplebibliography.py000066400000000000000000000026451424342136700231430ustar00rootroot00000000000000import re from docutils.core import publish_file import docutils.parsers.rst.directives as directives from pybtex_docutils import SimpleBibliography def html_citation_ref(key): return re.compile( fr'' fr'\[{key}]' fr'') def html_citation(key): return re.compile( fr'
\s*' fr'' fr'\[' fr'(?:)?' fr'{key}' fr'(?:)?' fr']' fr'') def test_simplebibliography(test_roots): directives.register_directive("bibliography", SimpleBibliography) source_path = test_roots / "test_simplebibliography" / "index.rst" result = publish_file(source_path=str(source_path), writer_name="html5") assert re.search(html_citation_ref('Mandel2009'), result) is not None assert re.search(html_citation_ref('Evensen2003'), result) is not None assert re.search(html_citation_ref('Lorenc1986'), result) is None assert re.search(html_citation('Mandel2009'), result) is not None assert re.search(html_citation('Evensen2003'), result) is not None assert re.search(html_citation('Lorenc1986'), result) is not None