diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 99006725..9ae24c94 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -67,7 +67,7 @@ jobs: - name: "Install build prerequisites (macOS)" if: matrix.name == 'macOS' run: | - brew install swig pylint + brew install swig - name: "Install build prerequisites (Windows)" if: startsWith(matrix.name, 'Windows') @@ -105,6 +105,30 @@ jobs: name: wheel-${{ matrix.name }}-${{ matrix.cpython }}-${{ matrix.architecture }} path: dist/*.whl - - name: "Lint" + + quality: + name: "Quality" + runs-on: "ubuntu-latest" + + steps: + - name: "Checkout the repository" + uses: actions/checkout@v4 + + - name: "Set up Python" + uses: actions/setup-python@v5 + with: + python-version: "3.12" + + - name: "Install build prerequisites" + run: | + sudo apt install libpcsclite-dev python3-all-dev swig + + - name: "Create a virtual environment" + run: | + python -m venv temp + temp/bin/python -m pip install --upgrade pip setuptools wheel + temp/bin/pip install tox + + - name: "Perform quality checks" run: | - ${{ env.venv-path }}/tox -e pylint + temp/bin/tox -e docs,pylint diff --git a/ChangeLog b/ChangeLog index 695595de..34da7cfe 100644 --- a/ChangeLog +++ b/ChangeLog @@ -6,6 +6,7 @@ Unreleased changes * Migrate CI to use the official Coveralls action * Standardize local and CI testing to use tox * Build wheels in CI for all supported Python versions + * Build the docs as a part of the test suite 2.1.1 (September 2024) ====================== diff --git a/Makefile b/Makefile index 540ed19d..1fc097cd 100644 --- a/Makefile +++ b/Makefile @@ -16,10 +16,6 @@ pypi: clean # files generated by swig rm -f src/smartcard/scard/scard.py rm -f src/smartcard/scard/scard_wrap.c - # files generated by sphinx - rm -rf src/smartcard/doc/_build - # files generated by pydoctor - rm -rf src/smartcard/doc/html rm -rf dist # Use the tox 'build' label to generate wheels for all Python versions. $(TOX) run -m build @@ -34,4 +30,11 @@ coverage: ChangeLog.git: git log --stat --decorate=short > $@ +.PHONY: sync-docs +sync-docs: + rsync \ + --recursive --verbose --update --rsh=ssh --links \ + build/docs/ \ + ludov@web.sourceforge.net:/home/project-web/pyscard/htdocs/ + .PHONY: clean build pypi test diff --git a/pyproject.toml b/pyproject.toml index 4fc0bf7e..b150fd24 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,3 +1,14 @@ [build-system] requires = ["setuptools","swig"] build-backend = "setuptools.build_meta" + + +# pydoctor +# -------- + +[tool.pydoctor] +add-package = ["src/smartcard"] +project-name = "PySCard" +project-url = "https://github.com/LudovicRousseau/pyscard" +html-output = "build/docs/apidocs" +warnings-as-errors = true diff --git a/src/smartcard/doc/Makefile b/src/smartcard/doc/Makefile deleted file mode 100644 index f376b709..00000000 --- a/src/smartcard/doc/Makefile +++ /dev/null @@ -1,153 +0,0 @@ -# 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/pyscard.qhcp" - @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/pyscard.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/pyscard" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/pyscard" - @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." diff --git a/src/smartcard/doc/conf.py b/src/smartcard/doc/conf.py index 7d6f26d4..c0e10144 100644 --- a/src/smartcard/doc/conf.py +++ b/src/smartcard/doc/conf.py @@ -1,42 +1,10 @@ -# -*- coding: utf-8 -*- -# -# pyscard documentation build configuration file, created by -# sphinx-quickstart on Thu Dec 4 14:38:51 2014. -# -# 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. - -import sys, os - -# 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. -#sys.path.insert(0, os.path.abspath('.')) -sys.path.insert(0, os.path.abspath('../..')) -sys.path.insert(0, os.path.abspath('../../build/lib.linux-x86_64-2.7')) - # -- 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.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' +extensions = [ + 'sphinx.ext.viewcode', +] # The master toctree document. master_doc = 'index' @@ -54,191 +22,9 @@ # The full version, including alpha/beta/rc tags. release = '2.1.1' -# 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 = 'pyscarddoc' - - -# -- 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', 'pyscard.tex', 'pyscard Documentation', - 'Ludovic Rousseau', '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', 'pyscard', 'pyscard Documentation', - ['Ludovic Rousseau'], 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', 'pyscard', 'pyscard Documentation', - 'Ludovic Rousseau', 'pyscard', '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' diff --git a/src/smartcard/doc/generate.sh b/src/smartcard/doc/generate.sh deleted file mode 100755 index 913612ee..00000000 --- a/src/smartcard/doc/generate.sh +++ /dev/null @@ -1,21 +0,0 @@ -#!/bin/bash - -set -e - -cd $(dirname $0) - -rm -rf html - -# Sphinx -make html -mv _build/html . - -# pydoctor -(cd .. && pydoctor \ - --project-name=PySCard \ - --project-url=https://github.com/LudovicRousseau/pyscard \ - --html-output=doc/html/apidocs \ - .) - -echo -echo "The documentation is available in file://$(pwd)/html/index.html" diff --git a/src/smartcard/doc/license.rst b/src/smartcard/doc/license.rst index 3af53785..f23b3264 100644 --- a/src/smartcard/doc/license.rst +++ b/src/smartcard/doc/license.rst @@ -16,3 +16,4 @@ along with pyscard; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA .. literalinclude:: ../../../LICENSE + :language: text diff --git a/src/smartcard/doc/sync.sh b/src/smartcard/doc/sync.sh deleted file mode 100755 index f23ec470..00000000 --- a/src/smartcard/doc/sync.sh +++ /dev/null @@ -1,10 +0,0 @@ -#!/bin/sh - -set -e -set -v - -cd $(dirname $0) - -ARGS="--recursive --verbose --update --rsh=ssh --links" - -rsync $ARGS html/ ludov@web.sourceforge.net:/home/project-web/pyscard/htdocs/ diff --git a/tox.ini b/tox.ini index 0b11e408..29688a2a 100644 --- a/tox.ini +++ b/tox.ini @@ -12,6 +12,7 @@ envlist = coverage_erase py{3.9, 3.10, 3.11, 3.12} coverage_report + docs skip_missing_interpreters = True labels = build=build-py{3.9, 3.10, 3.11, 3.12} @@ -61,3 +62,14 @@ deps = pylint commands = - pylint --errors-only smartcard + +[testenv:docs] +skip_install = True +recreate = True +deps = + -e. + sphinx + pydoctor +commands = + sphinx-build -nWEab html --keep-going src/smartcard/doc build/docs + pydoctor