cleanup documentation conf.py (#569)

* cleanup documentation conf.py

* add toml dep

* Update pyproject.toml

Co-authored-by: Brad Keryan <[email protected]>

* Update pyproject.toml

Co-authored-by: Brad Keryan <[email protected]>

* relock

---------

Co-authored-by: Brad Keryan <[email protected]>

CONTRIBUTING.md

@@ -109,7 +109,6 @@ can be verified once that has been completed.
       ```
       * **Note:** For `<semver>` we prefer to use `0.0.0-devX` style versions rather than the alpha
       versions you get from use a poetry version bump rule, like `prepatch`.
-   * If updating a minor or major version, update `version` and `release` in `docs/conf.py`.
    * Add a section to `CHANGELOG.md` for the new version with empty subsections.
 
 # Updating gRPC stubs when the .proto file is modified

docs/conf.py

@@ -1,157 +1,83 @@
-# -*- coding: utf-8 -*-
-#
-# NI-DAQmx Python API documentation build configuration file, created by
-# sphinx-quickstart on Thu Dec 15 09:40:36 2016.
-#
-# 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.
-
-# 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.
-#
+"""Sphinx Configuration File."""
+
+import datetime
 import os
+import pathlib
 import sys
+import toml
+
 sys.path.insert(0, os.path.abspath('../'))
 
 
 # -- 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.coverage',
               'sphinx.ext.viewcode',
               'sphinx.ext.napoleon']
 
-# Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
-
-# The suffix(es) of source filenames.
-# You can specify multiple suffix as a list of string:
-#
-# source_suffix = ['.rst', '.md']
 source_suffix = '.rst'
 
-# The master toctree document.
 master_doc = 'index'
 
-# General information about the project.
-project = u'NI-DAQmx Python API'
-copyright = u'2022, National Instruments'
-author = u'National Instruments'
-
-# 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 = u'1.0'
-# The full version. Since we adhere to semver, there is no reason to make this
-# more specific.
-release = u'1.0'
-
-# The language for content autogenerated by Sphinx. Refer to documentation
-# for a list of supported languages.
-#
-# This is also used if you do content translation via gettext catalogs.
-# Usually you set "language" from the command line for these cases.
+root_path = pathlib.Path(__file__).parent.parent
+pyproj_file = root_path / "pyproject.toml"
+proj_config = toml.loads(pyproj_file.read_text())
+
+project = proj_config["tool"]["poetry"]["name"]
+company = "National Instruments"
+author = company
+copyright = f"{datetime.datetime.now().year}, {company}"
+
+# Release is the full version, version is only the major component
+release = proj_config["tool"]["poetry"]["version"]
+version = ".".join(release.split(".")[:2])
+description = proj_config["tool"]["poetry"]["description"]
+
 language = 'en'
 
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-# This patterns also effect to html_static_path and html_extra_path
 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 
-# The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
 
-# If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = False
 
 
 # -- 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 = 'sphinx_rtd_theme'
 
-# 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 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 = []
 
 
 # -- Options for HTMLHelp output ------------------------------------------
 
-# Output file base name for HTML help builder.
 htmlhelp_basename = 'NI-DAQmxPythonAPIdoc'
 
 
 # -- 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, 'NI-DAQmxPythonAPI.tex', u'NI-DAQmx Python API Documentation',
-     u'National Instruments', 'manual'),
+    (master_doc, 'NI-DAQmxPythonAPI.tex', 'NI-DAQmx Python API Documentation',
+     'National Instruments', '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, 'ni-daqmxpythonapi', u'NI-DAQmx Python API Documentation',
+    (master_doc, 'ni-daqmxpythonapi', 'NI-DAQmx Python API Documentation',
      [author], 1)
 ]
 
 
 # -- 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, 'NI-DAQmxPythonAPI', u'NI-DAQmx Python API Documentation',
+    (master_doc, 'NI-DAQmxPythonAPI', 'NI-DAQmx Python API Documentation',
      author, 'NI-DAQmxPythonAPI', 'One line description of project.',
      'Miscellaneous'),
 ]