Skip to content

Commit

Permalink
Update various documentation links
Browse files Browse the repository at this point in the history
  • Loading branch information
EtiennePelletier committed Jun 3, 2021
1 parent af807aa commit b92f0cb
Show file tree
Hide file tree
Showing 13 changed files with 18 additions and 18 deletions.
2 changes: 1 addition & 1 deletion .editorconfig
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# EditorConfig is awesome: http://EditorConfig.org
# EditorConfig is awesome: https://EditorConfig.org

# top-most EditorConfig file
root = true
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ You need to install some dependencies to develop on flask-restx:
$ pip install -e .[dev]
An [Invoke](http://www.pyinvoke.org/) ``tasks.py`` is provided to simplify the common tasks:
An `Invoke <https://www.pyinvoke.org/>`_ ``tasks.py`` is provided to simplify the common tasks:

.. code-block:: console
Expand Down
4 changes: 2 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -175,8 +175,8 @@ Documentation
The documentation is hosted `on Read the Docs <http://flask-restx.readthedocs.io/en/latest/>`_


.. _Flask: http://flask.pocoo.org/
.. _Swagger: http://swagger.io/
.. _Flask: https://flask.palletsprojects.com/
.. _Swagger: https://swagger.io/


Contribution
Expand Down
2 changes: 1 addition & 1 deletion doc/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ BUILDDIR = _build

# User-friendly check for sphinx-build
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from https://sphinx-doc.org/)
endif

# Internal variables.
Expand Down
6 changes: 3 additions & 3 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -332,7 +332,7 @@


intersphinx_mapping = {
"flask": ("http://flask.pocoo.org/docs/", None),
"python": ("http://docs.python.org/", None),
"werkzeug": ("http://werkzeug.pocoo.org/docs/", None),
"flask": ("https://flask.palletsprojects.com/", None),
"python": ("https://docs.python.org/", None),
"werkzeug": ("https://werkzeug.palletsprojects.com/", None),
}
2 changes: 1 addition & 1 deletion doc/example.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Full example
============

Here is a full example of a `TodoMVC <http://todomvc.com/>`_ API.
Here is a full example of a `TodoMVC <https://todomvc.com/>`_ API.

.. code-block:: python
Expand Down
2 changes: 1 addition & 1 deletion doc/make.bat
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ if errorlevel 9009 (
echo.may add the Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.http://sphinx-doc.org/
echo.https://sphinx-doc.org/
exit /b 1
)

Expand Down
2 changes: 1 addition & 1 deletion doc/parsing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Request Parsing
The whole request parser part of Flask-RESTX is slated for removal and
will be replaced by documentation on how to integrate with other packages
that do the input/output stuff better
(such as `marshmallow <http://marshmallow.readthedocs.org>`_).
(such as `marshmallow <https://marshmallow.readthedocs.io/>`_).
This means that it will be maintained until 2.0 but consider it deprecated.
Don't worry, if you have code using that now and wish to continue doing so,
it's not going to go away any time too soon.
Expand Down
6 changes: 3 additions & 3 deletions doc/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Quick start

.. currentmodule:: flask_restx

This guide assumes you have a working understanding of `Flask <http://flask.pocoo.org>`_,
This guide assumes you have a working understanding of `Flask <https://flask.palletsprojects.com/>`_,
and that you have already installed both Flask and Flask-RESTX.
If not, then follow the steps in the :ref:`installation` section.

Expand Down Expand Up @@ -82,7 +82,7 @@ A minimal Flask-RESTX API looks like this:
Save this as api.py and run it using your Python interpreter.
Note that we've enabled `Flask debugging <http://flask.pocoo.org/docs/quickstart/#debug-mode>`_
Note that we've enabled `Flask debugging <https://flask.palletsprojects.com/quickstart/#debug-mode>`_
mode to provide code reloading and better error messages.

.. code-block:: console
Expand Down Expand Up @@ -152,7 +152,7 @@ You can try it like this:
{"todo2": "Change my brakepads"}
Or from python if you have the `Requests <http://docs.python-requests.org/>`_ library installed:
Or from python if you have the `Requests <https://docs.python-requests.org/>`_ library installed:

.. code-block:: python
Expand Down
2 changes: 1 addition & 1 deletion doc/swagger.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1067,4 +1067,4 @@ To disable Swagger UI entirely, set ``doc=False``:
api = Api(app, doc=False)
.. _vendor extensions: http://swagger.io/specification/#specification-extensions-128
.. _vendor extensions: https://swagger.io/specification/#specification-extensions
2 changes: 1 addition & 1 deletion flask_restx/cors.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ def crossdomain(
credentials=False,
):
"""
http://flask.pocoo.org/snippets/56/
https://web.archive.org/web/20190128010149/http://flask.pocoo.org/snippets/56/
"""
if methods is not None:
methods = ", ".join(sorted(x.upper() for x in methods))
Expand Down
2 changes: 1 addition & 1 deletion flask_restx/swagger.py
Original file line number Diff line number Diff line change
Expand Up @@ -480,7 +480,7 @@ def vendor_fields(self, doc, method):
"""
Extract custom 3rd party Vendor fields prefixed with ``x-``
See: http://swagger.io/specification/#specification-extensions-128
See: https://swagger.io/specification/#specification-extensions
"""
return dict(
(k if k.startswith("x-") else "x-{0}".format(k), v)
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
# replace doc references
(
r":doc:`(.+) <(.*)>`",
r"`\1 <http://flask-restx.readthedocs.org/en/stable\2.html>`_",
r"`\1 <https://flask-restx.readthedocs.io/en/stable\2.html>`_",
),
# replace issues references
(
Expand Down

0 comments on commit b92f0cb

Please sign in to comment.