Skip to content

Commit

Permalink
fix: updates from review
Browse files Browse the repository at this point in the history
- fixup doc genenerator, using config from main. Too many issues
  encountered trying to get a working autoapi version to work with
sphinx. Decided to adopt a more recent version of sphinx and utilized
Connexion/main's docs/conf.py file.
- add pipeline builds for supported python
- snap werkzeug version to address CVE's

Signed-off-by: Mike Marchetti <[email protected]>
  • Loading branch information
mfmarche committed Nov 11, 2024
1 parent 3d67f16 commit c023ecc
Show file tree
Hide file tree
Showing 8 changed files with 148 additions and 515 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/pipeline.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: [3.7, 3.8, 3.9]
python-version: ['3.9', '3.10', '3.11', '3.12']
steps:
- uses: actions/checkout@v2
- name: Set up Python ${{ matrix.python-version }}
Expand Down
7 changes: 0 additions & 7 deletions Dockerfile3.9

This file was deleted.

284 changes: 0 additions & 284 deletions README.md

This file was deleted.

49 changes: 31 additions & 18 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,20 +27,16 @@
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = ['autoapi.extension']

autoapi_type = 'python'
autoapi_options = ['members',
'inherited-members',
'undoc-members',
'show-inheritance',
'show-module-summary',
'special-members',
'imported-members']
autoapi_python_class_content = 'both'
autoapi_dirs = [
'../connexion'
extensions = [
'sphinx.ext.autodoc',
'sphinx_copybutton',
'sphinx_design',
'sphinx.ext.autosectionlabel',
'sphinxemoji.sphinxemoji',
]
autosectionlabel_prefix_document = True

autoclass_content = 'both'

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
Expand All @@ -62,11 +58,12 @@
# |version| and |release|, also used in various other places throughout the
# built documents.
#
import connexion
# The short X.Y version.
version = connexion.__version__.rsplit('.', 1)[0]
from importlib.metadata import version

# The full version, including alpha/beta/rc tags.
release = connexion.__version__
release = version('connexion')
# The short X.Y version.
version = release.rsplit('.', 1)[0]

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down Expand Up @@ -117,6 +114,18 @@
html_theme = "sphinx_rtd_theme"

html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

html_theme_options = {
'navigation_depth': 2
}

html_context = {
'display_github': True,
'github_user': 'spec-first',
'github_repo': 'connexion',
'github_version': 'main',
'conf_py_path': '/docs/'
}
except:
pass

Expand Down Expand Up @@ -147,7 +156,11 @@
# 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 = ['_static']
html_static_path = ['_static']

html_css_files = [
'css/default.css',
]

# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
Expand Down
Loading

0 comments on commit c023ecc

Please sign in to comment.