Add docs

Closes #35

Author: skirpichev

.github/workflows/test.yml

@@ -18,7 +18,25 @@ jobs:
           allow-prereleases: true
       - run: sudo apt-get update
       - run: sudo apt-get install libgmp-dev
+      - run: sudo apt-get install texlive texlive-latex-extra latexmk
+        if: matrix.python-version == 3.13
       - run: pip install --upgrade pip
       - run: pip --verbose install --editable .[develop]
+        if: matrix.python-version != 3.13
+      - run: pip --verbose install --editable .[develop,docs]
+        if: matrix.python-version == 3.13
       - run: ruff check
       - run: pytest
+      - name: Building docs
+        if: matrix.python-version == 3.13
+        run: |
+          sphinx-build --color -W --keep-going -b html docs build/sphinx/html
+          sphinx-build --color -W --keep-going -b latex docs build/sphinx/latex
+          make -C build/sphinx/latex all-pdf
+      - name: Archive build artifacts
+        uses: actions/upload-artifact@v4
+        if: matrix.python-version == 3.13
+        with:
+          path: |
+            build/sphinx/html/
+            build/sphinx/latex/python-gmp.pdf

.readthedocs.yaml

@@ -0,0 +1,19 @@
+version: 2
+formats:
+    - htmlzip
+    - pdf
+build:
+    os: ubuntu-22.04
+    apt_packages:
+        - libmpc-dev
+        - gcc
+    tools:
+        python: "3"
+python:
+    install:
+        - method: pip
+          path: .
+          extra_requirements:
+              - docs
+sphinx:
+    fail_on_warning: true

docs/conf.py

@@ -0,0 +1,53 @@
+"""
+python-gmp documentation build configuration file.
+
+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).
+"""
+
+import packaging.version
+
+import gmp
+
+# 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']
+
+# The name of a reST role (builtin or Sphinx extension) to use as the
+# default role, that is, for text marked up `like this`.
+default_role = 'py:obj'
+
+# Sphinx will warn about all references where the target cannot be found.
+nitpicky = True
+
+# This value selects if automatically documented members are sorted
+# alphabetical (value 'alphabetical'), by member type (value 'groupwise')
+# or by source order (value 'bysource').
+autodoc_member_order = 'groupwise'
+
+# The default options for autodoc directives. They are applied to all
+# autodoc directives automatically.
+autodoc_default_options = {'members': True}
+
+# General information about the project.
+project = gmp.__package__
+copyright = '2024, Sergey B Kirpichev'
+
+gmp_version = packaging.version.parse(gmp.__version__)
+
+# 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 short X.Y version.
+version = f"{gmp_version.major}.{gmp_version.minor}"
+# The full version, including alpha/beta/rc tags.
+release = gmp.__version__
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [('index', 'python-gmp.tex', 'python-gmp Documentation',
+                    'Sergey B Kirpichev', 'manual')]

docs/index.rst

@@ -0,0 +1,5 @@
+Documentation for python-gmp
+============================
+
+.. automodule:: gmp
+   :members:

pyproject.toml

@@ -39,6 +39,7 @@ content-type = 'text/x-rst'
 Homepage = 'https://github.com/diofant/python-gmp'
 'Source Code' = 'https://github.com/diofant/python-gmp'
 'Bug Tracker' = 'https://github.com/diofant/python-gmp/issues'
+Documentation = 'https://python-gmp.readthedocs.io/'
 
 [tool.setuptools]
 ext-modules = [{name = "gmp", sources = ["main.c"], libraries = ["gmp"]}]
@@ -53,6 +54,7 @@ ext-modules = [{name = "gmp", sources = ["main.c"], libraries = ["gmp"]}]
 tests = ["pytest", "hypothesis",
          "gmpy2; platform_python_implementation!='PyPy'"]
 develop = ["python-gmp[tests]", "ruff"]
+docs = ['sphinx']
 
 [tool.pytest.ini_options]
 addopts = "--durations=7"