8000 chore: relax test dependencies and remove unused dependencies (#638) · stern-shawn/twilio-python@fdaae97 · GitHub
[go: up one dir, main page]
Skip to content

Commit fdaae97

Browse files
author
childish-sambino
authored
chore: relax test dependencies and remove unused dependencies (twilio#638)
And add back the docs config files.
1 parent 4bb9673 commit fdaae97

File tree

6 files changed

+216
-11
lines changed

6 files changed

+216
-11
lines changed

‎.github/workflows/test-and-deploy.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,9 @@ jobs:
4343
- name: Run the tests
4444
run: make test-with-coverage
4545

46+
- name: Verify docs generation
47+
run: make docs
48+
4649
# only send coverage for PRs and branch updates
4750
- name: SonarCloud Scan
4851
if: (github.event_name == 'pull_request' || github.ref_type == 'branch') && !github.event.pull_request.head.repo.fork && matrix.python-version == '3.10'

‎.gitignore

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,9 @@ coverage.xml
2424

2525
.DS_Store
2626

27-
# sphinx build
28-
docs
27+
# sphinx build and rst folder
28+
docs/build
29+
docs/source/_rst
2930

3031
# PyCharm/IntelliJ
3132
.idea

‎docs/conf.py

Lines changed: 195 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,195 @@
1+
# -*- coding: utf-8 -*-
2+
#
3+
# Configuration file for the Sphinx documentation builder.
4+
#
5+
# This file does only contain a selection of the most common options. For a
6+
# full list see the documentation:
7+
# http://www.sphinx-doc.org/en/master/config
8+
9+
10+
# -- Path setup --------------------------------------------------------------
11+
12+
# If extensions (or modules to document with autodoc) are in another directory,
13+
# add these directories to sys.path here. If the directory is relative to the
14+
# documentation root, use os.path.abspath to make it absolute, like shown here.
15+
#
16+
import os
17+
import sys
18+
sys.path.insert(0, os.path.abspath('..'))
19+
from twilio import __version__
20+
21+
22+
# -- Project information -----------------------------------------------------
23+
24+
project = 'twilio-python'
25+
copyright = '2023, Twilio'
26+
author = 'Twilio'
27+
28+
# The short X.Y version
29+
version = __version__
30+
# The full version, including alpha/beta/rc tags
31+
release = __version__
32+
33+
34+
# -- General configuration ---------------------------------------------------
35+
36+
# If your documentation needs a minimal Sphinx version, state it here.
37+
#
38+
# needs_sphinx = '1.0'
39+
40+
# Add any Sphinx extension module names here, as strings. They can be
41+
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
42+
# ones.
43+
extensions = [
44+
'sphinx.ext.autodoc',
45+
'sphinx.ext.doctest',
46+
'sphinx.ext.intersphinx',
47+
'sphinx.ext.coverage',
48+
'sphinx.ext.ifconfig',
49+
'sphinx.ext.viewcode',
50+
'recommonmark'
51+
]
52+
53+
# Add any paths that contain templates here, relative to this directory.
54+
templates_path = ['source/_templates']
55+
56+
# The suffix(es) of source filenames.
57+
# You can specify multiple suffix as a list of string:
58+
#
59+
source_suffix = {
60+
'.rst': 'restructuredtext',
61+
'.md': 'markdown',
62+
}
63+
64+
# The master toctree document.
65+
master_doc = 'index'
66+
67+
# The language for content autogenerated by Sphinx. Refer to documentation
68+
# for a list of supported languages.
69+
#
70+
# This is also used if you do content translation via gettext catalogs.
71+
# Usually you set "language" from the command line for these cases.
72+
language = None
73+
74+
# List of patterns, relative to source directory, that match files and
75+
# directories to ignore when looking for source files.
76+
# This pattern also affects html_static_path and html_extra_path .
77+
exclude_patterns = []
78+
79+
# The name of the Pygments (syntax highlighting) style to use.
80+
pygments_style = 'sphinx'
81+
82+
83+
# -- Options for HTML output -------------------------------------------------
84+
85+
# The theme to use for HTML and HTML Help pages. See the documentation for
86+
# a list of builtin themes.
87+
#
88+
html_theme = 'alabaster'
89+
90+
# Theme options are theme-specific and customize the look and feel of a theme
91+
# further. For a list of options available for each theme, see the
92+
# documentation.
93+
#
94+
# html_theme_options = {}
95+
96+
html_static_path = ['source/_static']
97+
98+
# Custom sidebar templates, must be a dictionary that maps document names
99+
# to template names.
100+
#
101+
# The default sidebars (for documents that don't match any pattern) are
102+
# defined by theme itself. Builtin themes are using these templates by
103+
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
104+
# 'searchbox.html']``.
105+
#
106+
html_sidebars = {
107+
'**': [ 'sidebarintro.html', 'localtoc.html', 'relations.html',
108+
'sourcelink.html', 'searchbox.html']
109+
}
110+
111+
112+
# -- Options for HTMLHelp output ---------------------------------------------
113+
114+
# Output file base name for HTML help builder.
115+
htmlhelp_basename = 'twilio-pythondoc'
116+
117+
118+
# -- Options for LaTeX output ------------------------------------------------
119+
120+
latex_elements = {
121+
# The paper size ('letterpaper' or 'a4paper').
122+
#
123+
# 'papersize': 'letterpaper',
124+
125+
# The font size ('10pt', '11pt' or '12pt').
126+
#
127+
# 'pointsize': '10pt',
128+
129+
# Additional stuff for the LaTeX preamble.
130+
#
131+
# 'preamble': '',
132+
133+
# Latex figure (float) alignment
134+
#
135+
# 'figure_align': 'htbp',
136+
}
137+
138+
# Grouping the document tree into LaTeX files. List of tuples
139+
# (source start file, target name, title,
140+
# author, documentclass [howto, manual, or own class]).
141+
latex_documents = [
142+
(master_doc, 'twilio-python.tex', 'twilio-python Documentation',
143+
'Twilio', 'manual'),
144+
]
145+
146+
147+
# -- Options for manual page output ------------------------------------------
148+
149+
# One entry per manual page. List of tuples
150+
# (source start file, name, description, authors, manual section).
151+
man_pages = [
152+
(master_doc, 'twilio-python', 'twilio-python Documentation',
153+
[author], 1)
154+
]
155+
156+
157+
# -- Options for Texinfo output ----------------------------------------------
158+
159+
# Grouping the document tree into Texinfo files. List of tuples
160+
# (source start file, target name, title, author,
161+
# dir menu entry, description, category)
162+
texinfo_documents = [
163+
(master_doc, 'twilio-python', 'twilio-python Documentation',
164+
author, 'twilio-python', 'One line description of project.',
165+
'Miscellaneous'),
166+
]
167+
168+
169+
# -- Options for Epub output -------------------------------------------------
170+
171+
# Bibliographic Dublin Core info.
172+
epub_title = project
173+
epub_author = author
174+
epub_publisher = author
175+
epub_copyright = copyright
176+
177+
# The unique identifier of the text. This can be a ISBN number
178+
# or the project homepage.
179+
#
180+
# epub_identifier = ''
181+
182+
# A unique identification for the text.
183+
#
184+
# epub_uid = ''
185+
186+
# A list of files that should not be packed into the epub file.
187+
epub_exclude_files = ['search.html']
188+
189+
190+
# -- Extension configuration -------------------------------------------------
191+
192+
# -- Options for intersphinx extension ---------------------------------------
193+
194+
# Example configuration for intersphinx: refer to the Python standard library.
195+
intersphinx_mapping = {'https://docs.python.org/': None}

‎docs/source/_templates/sidebarintro.html

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<h3><a href="https://www.twilio.com/docs/libraries/python">About twilio-python</a></h3>
2+
<p>
3+
A Python module for communicating with the Twilio API and generating <a href="https://www.twilio.com/docs/api/twiml/">TwiML</a>.
4+
</p>
5+
6+
<h3>Useful Links</h3>
7+
<ul>
8+
<li><a href="https://www.twilio.com/docs/libraries/python">Twilio's Python Helper Library Docs</a></li>
9+
<li><a href="https://pypi.org/project/twilio/">twilio @ PyPI</a></li>
10+
<li><a href="https://github.com/twilio/twilio-python">twilio-python @ GitHub</a></li>
11+
</ul>

‎requirements.txt

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
1-
flake8
2-
mock
1+
pygments>=2.7.4 # not directly required, pinned by Snyk to avoid a vulnerability
2+
pytz
33
requests>=2.0.0
44
PyJWT>=2.0.0, <3.0.0
5-
twine
6-
pygments>=2.7.4 # not directly required, pinned by Snyk to avoid a vulnerability

‎tests/requirements.txt

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,11 @@
1-
Sphinx==1.8.0
2-
jinja2==3.0.0
3-
mock==0.8.0
1+
Sphinx>=1.8.0
2+
mock
43
pytest
54
pytest-cov
65
coverage
76
flake8
8-
mccabe
97
wheel>=0.22.0
108
cryptography
11-
twine
129
recommonmark
1310
django
1411
multidict

0 commit comments

Comments
 (0)
0