Merge branch 'master' into relax-dependencies

HISTORY.rst

@@ -4,6 +4,7 @@ History
 
 0.3.8 (2024-09-29)
 ------------------
+* Upgrade readthedocs to PyData Sphinx Theme (:pr:`323`)
 * Upgrade backend to poetry (:pr:`322`)
 * Optimise the beam cube implementation (:pr:`320`)
 * Support an `init_state` argument into both `Term.init_fields`

docs/conf.py

@@ -19,13 +19,6 @@
 # absolute, like shown here.
 #
 
-import importlib
-import os
-import sys
-
-import sphinx_rtd_theme
-import africanus
-
 # -- General configuration ---------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
@@ -94,7 +87,9 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = "sphinx_rtd_theme"
+html_theme = "pydata_sphinx_theme"
+
+html_title = "Codex Africanus"
 
 # 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
@@ -114,62 +109,6 @@
 htmlhelp_basename = "africanusdoc"
 
 
-# -- 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,
-        "africanus.tex",
-        "Codex Africanus Documentation",
-        "Simon Perkins",
-        "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, "africanus", "Codex Africanus Documentation", [author], 1)]
-
-numpydoc_class_members_toctree = 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 = [
-    (
-        master_doc,
-        "africanus",
-        "Codex Africanus Documentation",
-        author,
-        "africanus",
-        "One line description of project.",
-        "Miscellaneous",
-    ),
-]
-
 extlinks = {
     "issue": ("https://github.com/ska-sa/codex-africanus/issues/%s", "GH#%s"),
     "pr": ("https://github.com/ska-sa/codex-africanus/pull/%s", "GH#%s"),

docs/index.rst

@@ -6,7 +6,6 @@ Welcome to Codex Africanus's documentation!
    :maxdepth: 2
    :caption: Contents:
 
-   readme
    installation
    usage
    cmdline-utils

docs/installation.rst

@@ -49,31 +49,3 @@ To install the complete set of dependencies including CUDA:
 
 .. _pip: https://pip.pypa.io
 .. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/
-
-
-From sources
-------------
-
-The sources for Codex Africanus can be downloaded from the `Github repo`_.
-
-You can either clone the public repository:
-
-.. code-block:: console
-
-    $ git clone git://github.com/ska-sa/codex-africanus
-
-Or download the `tarball`_:
-
-.. code-block:: console
-
-    $ curl  -OL https://github.com/ska-sa/codex-africanus/tarball/master
-
-Once you have a copy of the source, you can install it with:
-
-.. code-block:: console
-
-    $ python setup.py install
-
-
-.. _Github repo: https://github.com/ska-sa/codex-africanus
-.. _tarball: https://github.com/ska-sa/codex-africanus/tarball/master