Rename to drf-yasg
drf-swagger was already taken
This commit is contained in:
+2
-2
@@ -4,7 +4,7 @@
|
||||
# You can set these variables from the command line.
|
||||
SPHINXOPTS =
|
||||
SPHINXBUILD = sphinx-build
|
||||
SPHINXPROJ = drf-swagger
|
||||
SPHINXPROJ = drf-yasg
|
||||
SOURCEDIR = .
|
||||
BUILDDIR = _build
|
||||
|
||||
@@ -17,4 +17,4 @@ help:
|
||||
# Catch-all target: route all unknown targets to Sphinx using the new
|
||||
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
||||
%: Makefile
|
||||
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
||||
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
||||
|
||||
+11
-11
@@ -1,7 +1,7 @@
|
||||
#!/usr/bin/env python3
|
||||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# drf-swagger documentation build configuration file, created by
|
||||
# drf-yasg documentation build configuration file, created by
|
||||
# sphinx-quickstart on Sun Dec 10 15:20:34 2017.
|
||||
import os
|
||||
import sys
|
||||
@@ -33,7 +33,7 @@ source_suffix = '.rst'
|
||||
master_doc = 'index'
|
||||
|
||||
# General information about the project.
|
||||
project = 'drf-swagger'
|
||||
project = 'drf-yasg'
|
||||
copyright = '2017, Cristi V.'
|
||||
author = 'Cristi V.'
|
||||
|
||||
@@ -42,7 +42,7 @@ author = 'Cristi V.'
|
||||
# built documents.
|
||||
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = get_distribution('drf_swagger').version
|
||||
release = get_distribution('drf_yasg').version
|
||||
|
||||
# The short X.Y.Z version.
|
||||
version = '.'.join(release.split('.')[:3])
|
||||
@@ -62,7 +62,7 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
|
||||
# The name of the Pygments (syntax highlighting) style to use.
|
||||
pygments_style = 'sphinx'
|
||||
|
||||
modindex_common_prefix = ['drf_swagger.']
|
||||
modindex_common_prefix = ['drf_yasg.']
|
||||
|
||||
# If true, `todo` and `todoList` produce output, else they produce nothing.
|
||||
todo_include_todos = False
|
||||
@@ -103,7 +103,7 @@ html_sidebars = {
|
||||
# -- Options for HTMLHelp output ------------------------------------------
|
||||
|
||||
# Output file base name for HTML help builder.
|
||||
htmlhelp_basename = 'drf-swaggerdoc'
|
||||
htmlhelp_basename = 'drf-yasgdoc'
|
||||
|
||||
# -- Options for LaTeX output ---------------------------------------------
|
||||
|
||||
@@ -129,7 +129,7 @@ latex_elements = {
|
||||
# (source start file, target name, title,
|
||||
# author, documentclass [howto, manual, or own class]).
|
||||
latex_documents = [
|
||||
(master_doc, 'drf-swagger.tex', 'drf-swagger Documentation',
|
||||
(master_doc, 'drf-yasg.tex', 'drf-yasg Documentation',
|
||||
'Cristi V.', 'manual'),
|
||||
]
|
||||
|
||||
@@ -138,7 +138,7 @@ latex_documents = [
|
||||
# One entry per manual page. List of tuples
|
||||
# (source start file, name, description, authors, manual section).
|
||||
man_pages = [
|
||||
(master_doc, 'drf-swagger', 'drf-swagger Documentation',
|
||||
(master_doc, 'drf-yasg', 'drf-yasg Documentation',
|
||||
[author], 1)
|
||||
]
|
||||
|
||||
@@ -148,8 +148,8 @@ man_pages = [
|
||||
# (source start file, target name, title, author,
|
||||
# dir menu entry, description, category)
|
||||
texinfo_documents = [
|
||||
(master_doc, 'drf-swagger', 'drf-swagger Documentation',
|
||||
author, 'drf-swagger', 'One line description of project.',
|
||||
(master_doc, 'drf-yasg', 'drf-yasg Documentation',
|
||||
author, 'drf-yasg', 'One line description of project.',
|
||||
'Miscellaneous'),
|
||||
]
|
||||
|
||||
@@ -200,7 +200,7 @@ from django.conf import settings # noqa: E402
|
||||
|
||||
settings.configure()
|
||||
|
||||
import drf_swagger.views # noqa: E402
|
||||
import drf_yasg.views # noqa: E402
|
||||
|
||||
# instantiate a SchemaView in the views module to make it available to autodoc
|
||||
drf_swagger.views.SchemaView = drf_swagger.views.get_schema_view(None)
|
||||
drf_yasg.views.SchemaView = drf_yasg.views.get_schema_view(None)
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
Custom schema generation
|
||||
########################
|
||||
|
||||
If the default spec generation does not quite match what you were hoping to achieve, ``drf-swagger`` provides some
|
||||
If the default spec generation does not quite match what you were hoping to achieve, ``drf-yasg`` provides some
|
||||
custom behavior hooks by default.
|
||||
|
||||
*********************
|
||||
|
||||
+1
-1
@@ -4,4 +4,4 @@ Customizing the web UI
|
||||
|
||||
There is currently no pluggable way of customizing the web UI apart from the settings available in
|
||||
:ref:`swagger-ui-settings` and :ref:`redoc-ui-settings`. If you really need to, you can override one of the
|
||||
``drf-swagger/swagger-ui.html`` or ``drf-swagger/redoc.html`` templates that are used for rendering.
|
||||
``drf-yasg/swagger-ui.html`` or ``drf-yasg/redoc.html`` templates that are used for rendering.
|
||||
|
||||
@@ -4,7 +4,7 @@ drf\_swagger package
|
||||
drf\_swagger\.app\_settings
|
||||
----------------------------------
|
||||
|
||||
.. automodule:: drf_swagger.app_settings
|
||||
.. automodule:: drf_yasg.app_settings
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -12,7 +12,7 @@ drf\_swagger\.app\_settings
|
||||
drf\_swagger\.codecs
|
||||
---------------------------
|
||||
|
||||
.. automodule:: drf_swagger.codecs
|
||||
.. automodule:: drf_yasg.codecs
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -21,7 +21,7 @@ drf\_swagger\.codecs
|
||||
drf\_swagger\.errors
|
||||
---------------------------
|
||||
|
||||
.. automodule:: drf_swagger.errors
|
||||
.. automodule:: drf_yasg.errors
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -29,7 +29,7 @@ drf\_swagger\.errors
|
||||
drf\_swagger\.generators
|
||||
-------------------------------
|
||||
|
||||
.. automodule:: drf_swagger.generators
|
||||
.. automodule:: drf_yasg.generators
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -37,7 +37,7 @@ drf\_swagger\.generators
|
||||
drf\_swagger\.inspectors
|
||||
-------------------------------
|
||||
|
||||
.. automodule:: drf_swagger.inspectors
|
||||
.. automodule:: drf_yasg.inspectors
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -45,7 +45,7 @@ drf\_swagger\.inspectors
|
||||
drf\_swagger\.middleware
|
||||
-------------------------------
|
||||
|
||||
.. automodule:: drf_swagger.middleware
|
||||
.. automodule:: drf_yasg.middleware
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -53,7 +53,7 @@ drf\_swagger\.middleware
|
||||
drf\_swagger\.openapi
|
||||
----------------------------
|
||||
|
||||
.. automodule:: drf_swagger.openapi
|
||||
.. automodule:: drf_yasg.openapi
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -61,7 +61,7 @@ drf\_swagger\.openapi
|
||||
drf\_swagger\.renderers
|
||||
------------------------------
|
||||
|
||||
.. automodule:: drf_swagger.renderers
|
||||
.. automodule:: drf_yasg.renderers
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -69,7 +69,7 @@ drf\_swagger\.renderers
|
||||
drf\_swagger\.utils
|
||||
--------------------------
|
||||
|
||||
.. automodule:: drf_swagger.utils
|
||||
.. automodule:: drf_yasg.utils
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -77,7 +77,7 @@ drf\_swagger\.utils
|
||||
drf\_swagger\.views
|
||||
--------------------------
|
||||
|
||||
.. automodule:: drf_swagger.views
|
||||
.. automodule:: drf_yasg.views
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
+3
-3
@@ -1,9 +1,9 @@
|
||||
.. drf-swagger documentation master file, created by
|
||||
.. drf-yasg documentation master file, created by
|
||||
sphinx-quickstart on Sun Dec 10 15:20:34 2017.
|
||||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
|
||||
drf-swagger
|
||||
drf-yasg
|
||||
===========
|
||||
|
||||
.. toctree::
|
||||
@@ -28,4 +28,4 @@ Source code documentation
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
drf_swagger.rst
|
||||
drf_yasg.rst
|
||||
|
||||
+1
-1
@@ -9,7 +9,7 @@ if "%SPHINXBUILD%" == "" (
|
||||
)
|
||||
set SOURCEDIR=.
|
||||
set BUILDDIR=_build
|
||||
set SPHINXPROJ=drf-swagger
|
||||
set SPHINXPROJ=drf-yasg
|
||||
|
||||
if "%1" == "" goto help
|
||||
|
||||
|
||||
Reference in New Issue
Block a user