LukeParke/connexion
1
0
Fork 0
mirror of https://github.com/LukeHagar/connexion.git synced 2025-12-06 04:19:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

WIP

Browse Source
This commit is contained in:
Robbe Sneyders
2023-06-07 22:38:59 +02:00
parent 0c0c517cf6
commit c267766670
4 changed files with 12 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
docs/conf.py
View File

@@ -92,7 +92,7 @@ exclude_patterns = ['_build']
# show_authors = False # show_authors = False
# The name of the Pygments (syntax highlighting) style to use. # The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx' # pygments_style = "material"
# A list of ignored prefixes for module index sorting. # A list of ignored prefixes for module index sorting.
# modindex_common_prefix = [] # modindex_common_prefix = []
@@ -105,19 +105,20 @@ pygments_style = 'sphinx'
# The theme to use for HTML and HTML Help pages. See the documentation for # The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes. # a list of builtin themes.
try: html_theme = "furo"
import sphinx_rtd_theme
html_theme = "sphinx_rtd_theme"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
except:
pass
# Theme options are theme-specific and customize the look and feel of a 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 # further. For a list of options available for each theme, see the
# documentation. # documentation.
# html_theme_options = {} html_theme_options = {
"announcement": "<b>This is the WIP documentation for Connexion 3.0, which is in alpha. "
"Find the stable version "
"<a href=https://connexion.readthedocs.io/en/stable/>here</a>.</b>",
"light_css_variables": {
"color-announcement-background": "#ff5252",
"color-announcement-text": "#ffffff"
}
}
# Add any paths that contain custom themes here, relative to this directory. # Add any paths that contain custom themes here, relative to this directory.
# html_theme_path = [] # html_theme_path = []

7
docs/index.rst
View File

@@ -3,13 +3,6 @@
You can adapt this file completely to your liking, but it should at least You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive. contain the root `toctree` directive.
.. warning::
This is the WIP documentation for Connexion 3.0 which is currently in alpha. You might want to
read the documentation for the latest `stable version`_ instead.
If you want to try out Connexion 3.0, refer to the :ref: `v3`_ section.
Welcome to Connexion's documentation! Welcome to Connexion's documentation!
===================================== =====================================

7
docs/v3.rst
View File

@@ -1,10 +1,3 @@
.. warning::
Do not use Connexion 3.0 in production yet!
Connexion 3.0 is currently available in alpha to give users the ability to test it and provide
feedback while we further polish the codebase and update the documentation.
Getting started with Connexion 3.0 Getting started with Connexion 3.0
================================== ==================================

2
pyproject.toml
View File

@@ -79,7 +79,7 @@ pytest-cov = "~2.12.1"
sphinx = "5.3.0" sphinx = "5.3.0"
sphinx_copybutton = "0.5.2" sphinx_copybutton = "0.5.2"
sphinx_design = "0.4.1" sphinx_design = "0.4.1"
sphinx-rtd-theme = "1.2.0" furo = "2023.03.27"
[build-system] [build-system]
requires = ["poetry-core>=1.2.0"] requires = ["poetry-core>=1.2.0"]