From fdaae97c8051aed18ad1be642805af87e70fd9c2 Mon Sep 17 00:00:00 2001 From: childish-sambino Date: Thu, 19 Jan 2023 16:39:26 -0600 Subject: [PATCH] chore: relax test dependencies and remove unused dependencies (#638) And add back the docs config files. --- .github/workflows/test-and-deploy.yml | 3 + .gitignore | 5 +- docs/conf.py | 195 +++++++++++++++++++++++ docs/source/_templates/sidebarintro.html | 11 ++ requirements.txt | 6 +- tests/requirements.txt | 7 +- 6 files changed, 216 insertions(+), 11 deletions(-) create mode 100644 docs/conf.py create mode 100644 docs/source/_templates/sidebarintro.html diff --git a/.github/workflows/test-and-deploy.yml b/.github/workflows/test-and-deploy.yml index 58be384898..cbace58191 100644 --- a/.github/workflows/test-and-deploy.yml +++ b/.github/workflows/test-and-deploy.yml @@ -43,6 +43,9 @@ jobs: - name: Run the tests run: make test-with-coverage + - name: Verify docs generation + run: make docs + # only send coverage for PRs and branch updates - name: SonarCloud Scan if: (github.event_name == 'pull_request' || github.ref_type == 'branch') && !github.event.pull_request.head.repo.fork && matrix.python-version == '3.10' diff --git a/.gitignore b/.gitignore index 6dab06cea0..01e1b686c5 100644 --- a/.gitignore +++ b/.gitignore @@ -24,8 +24,9 @@ coverage.xml .DS_Store -# sphinx build -docs +# sphinx build and rst folder +docs/build +docs/source/_rst # PyCharm/IntelliJ .idea diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000000..52bd1c8946 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,195 @@ +# -*- coding: utf-8 -*- +# +# Configuration file for the Sphinx documentation builder. +# +# This file does only contain a selection of the most common options. For a +# full list see the documentation: +# http://www.sphinx-doc.org/en/master/config + + +# -- Path setup -------------------------------------------------------------- + +# 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. +# +import os +import sys +sys.path.insert(0, os.path.abspath('..')) +from twilio import __version__ + + +# -- Project information ----------------------------------------------------- + +project = 'twilio-python' +copyright = '2023, Twilio' +author = 'Twilio' + +# The short X.Y version +version = __version__ +# The full version, including alpha/beta/rc tags +release = __version__ + + +# -- 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.doctest', + 'sphinx.ext.intersphinx', + 'sphinx.ext.coverage', + 'sphinx.ext.ifconfig', + 'sphinx.ext.viewcode', + 'recommonmark' +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['source/_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +source_suffix = { + '.rst': 'restructuredtext', + '.md': 'markdown', +} + +# The master toctree document. +master_doc = 'index' + +# 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. +language = None + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path . +exclude_patterns = [] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + + +# -- 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 = 'alabaster' + +# 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 = {} + +html_static_path = ['source/_static'] + +# Custom sidebar templates, must be a dictionary that maps document names +# to template names. +# +# The default sidebars (for documents that don't match any pattern) are +# defined by theme itself. Builtin themes are using these templates by +# default: ``['localtoc.html', 'relations.html', 'sourcelink.html', +# 'searchbox.html']``. +# +html_sidebars = { + '**': [ 'sidebarintro.html', 'localtoc.html', 'relations.html', + 'sourcelink.html', 'searchbox.html'] +} + + +# -- Options for HTMLHelp output --------------------------------------------- + +# Output file base name for HTML help builder. +htmlhelp_basename = 'twilio-pythondoc' + + +# -- 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, 'twilio-python.tex', 'twilio-python Documentation', + 'Twilio', '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, 'twilio-python', 'twilio-python 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, 'twilio-python', 'twilio-python Documentation', + author, 'twilio-python', 'One line description of project.', + 'Miscellaneous'), +] + + +# -- Options for Epub output ------------------------------------------------- + +# Bibliographic Dublin Core info. +epub_title = project +epub_author = author +epub_publisher = author +epub_copyright = copyright + +# The unique identifier of the text. This can be a ISBN number +# or the project homepage. +# +# epub_identifier = '' + +# A unique identification for the text. +# +# epub_uid = '' + +# A list of files that should not be packed into the epub file. +epub_exclude_files = ['search.html'] + + +# -- Extension configuration ------------------------------------------------- + +# -- Options for intersphinx extension --------------------------------------- + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = {'https://docs.python.org/': None} diff --git a/docs/source/_templates/sidebarintro.html b/docs/source/_templates/sidebarintro.html new file mode 100644 index 0000000000..d362c5dabb --- /dev/null +++ b/docs/source/_templates/sidebarintro.html @@ -0,0 +1,11 @@ +

About twilio-python

+

+ A Python module for communicating with the Twilio API and generating TwiML. +

+ +

Useful Links

+ diff --git a/requirements.txt b/requirements.txt index dda67c612d..a658cbc6ff 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,6 +1,4 @@ -flake8 -mock +pygments>=2.7.4 # not directly required, pinned by Snyk to avoid a vulnerability +pytz requests>=2.0.0 PyJWT>=2.0.0, <3.0.0 -twine -pygments>=2.7.4 # not directly required, pinned by Snyk to avoid a vulnerability diff --git a/tests/requirements.txt b/tests/requirements.txt index 23a0772b60..6e1d41b419 100644 --- a/tests/requirements.txt +++ b/tests/requirements.txt @@ -1,14 +1,11 @@ -Sphinx==1.8.0 -jinja2==3.0.0 -mock==0.8.0 +Sphinx>=1.8.0 +mock pytest pytest-cov coverage flake8 -mccabe wheel>=0.22.0 cryptography -twine recommonmark django multidict