Merge pull request mpmath#578 from skirpichev/cleanup

Cleanup top-level dir & misc fixes

Author: fredrik-johansson

.github/workflows/test.yml

@@ -15,11 +15,11 @@ jobs:
     - name: Install libs
       run: |
         sudo apt update
-        sudo apt install libmpc-dev
+        sudo apt install libmpc-dev latexmk texlive-xetex
     - name: Install dependencies
       run: |
         pip install --upgrade --force-reinstall setuptools pip
-        pip install --upgrade .[develop,gmpy]
+        pip install --upgrade .[develop,gmpy,docs]
     - name: Linting with pycodestyle, etc
       run: |
         python -We:invalid -m compileall -f mpmath -q
@@ -36,8 +36,22 @@ jobs:
       run: |
         pytest
         codecov --required
+    - name: Building docs
+      run: |
+        python setup.py build_sphinx -c doc/source -b html,latex
+        make -C build/sphinx/latex all-pdf
     - name: Make packages
       run: python setup.py sdist bdist_wheel
+    - name: Archive production artifacts
+      uses: actions/upload-artifact@v2
+      if: matrix.python-version == 3.6
+      with:
+        path: |
+          dist/
+          build/sphinx/html/
+          build/sphinx/latex/mpmath.pdf
+          coverage.xml
+          build/coverage/html/
     - name: Publish package on PyPI
       if: matrix.python-version == 3.9 && github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags')
       uses: pypa/gh-action-pypi-publish@v1.4.2

.gitignore

@@ -10,6 +10,7 @@
 
 # Regular Python bytecode file
 *.pyc
+__pycache__/
 
 # Optimized Python bytecode file
 *.pyo
@@ -57,4 +58,4 @@ mpmath.egg-info/
 htmlcov/
 
 # Visual Studio files
-.vs/
+.vs/

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2005-2018 Fredrik Johansson and mpmath contributors
+Copyright (c) 2005-2021 Fredrik Johansson and mpmath contributors
 
 All rights reserved.
 

MANIFEST.in

@@ -1,138 +1,48 @@
-# -*- coding: utf-8 -*-
-#
-# mpmath documentation build configuration file, created by
-# sphinx-quickstart on Sun Apr 13 00:14:30 2008.
-#
-# This file is execfile()d with the current directory set to its containing dir.
-#
-# The contents of this file are pickled, so don't put values in the namespace
-# that aren't pickleable (module imports are okay, they're removed automatically).
-#
-# All configuration values have a default value; values that are commented out
-# serve to show the default value.
+"""
+Mpmath documentation build configuration file.
 
-import sys
+This file is execfile()d with the current directory set to its
+containing dir.
 
-# If your extensions are in another directory, add it here.
-sys.path.insert(0, '../..')
+The contents of this file are pickled, so don't put values in the
+namespace that aren't pickleable (module imports are okay, they're
+removed automatically).
+"""
 
-# General configuration
-# ---------------------
-
-# 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.mathjax']
+import mpmath
 
-# MathJax file, which is free to use.  See http://www.mathjax.org/docs/2.0/start.html
-# mathjax_path = 'http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS_HTML-full'
 
-# Add any paths that contain templates here, relative to this directory.
-templates_path = []
+# Add any Sphinx extension module names here, as strings.
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.mathjax']
 
 # The suffix of source filenames.
 source_suffix = '.txt'
 
 # The master toctree document.
 master_doc = 'index'
 
-# General substitutions.
+# Project information.
 project = 'mpmath'
 copyright = '2007-2021, Fredrik Johansson and mpmath developers'
-
-# The default replacements for |version| and |release|, also used in various
-# other places throughout the built documents.
-#
-# The short X.Y version.
-import mpmath
 version = mpmath.__version__
-# The full version, including alpha/beta/rc tags.
-release = mpmath.__version__
+release = version
 
-# 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.
+# Define how the current time is formatted using time.strftime().
 today_fmt = '%B %d, %Y'
 
-# List of documents that shouldn't be included in the build.
-#unused_docs = []
-
-# 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'
-
-
-# Options for HTML output
-# -----------------------
-
 # The "theme" that the HTML output should use.
 html_theme = 'classic'
 
-# 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 = []
-
-# 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
-
-# Content template for the index page.
-#html_index = ''
-
-# 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_use_modindex = True
-
-# If true, the reST sources are included in the HTML build as _sources/<name>.
-#html_copy_source = True
-
 # Output file base name for HTML help builder.
 htmlhelp_basename = 'mpmathdoc'
 
-
-# Options for LaTeX output
-# ------------------------
-
-# The paper size ('letter' or 'a4').
-#latex_paper_size = 'letter'
-
-# The font size ('10pt', '11pt' or '12pt').
-#latex_font_size = '10pt'
-
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, document class [howto/manual]).
-latex_documents = [(master_doc, 'main.tex', 'mpmath documentation',
+latex_documents = [(master_doc, 'mpmath.tex', 'mpmath documentation',
                     r'Fredrik Johansson \and mpmath contributors', 'manual')]
 
 # Additional stuff for the LaTeX preamble.
 latex_preamble = r'\usepackage{amsfonts}'
 
-# Documents to append as an appendix to all manuals.
-#latex_appendices = []
-
-# If false, no module index is generated.
-#latex_use_modindex = True
-
+# The name of default reST role, that is, for text marked up `like this`.
 default_role = 'math'
-pngmath_dvipng_args = ['-gamma 1.5', '-D 110']

TODO

@@ -37,6 +37,7 @@ develop = %(tests)s
           wheel
 gmpy =
     gmpy2>=2.1.0a4; platform_python_implementation!="PyPy"
+docs = sphinx
 [pycodestyle]
 select = E101,W191,W291,W293,E111,E112,E113,W292,W391
 exclude = .eggs,.git