Skip to content
This repository was archived by the owner on May 5, 2023. It is now read-only.

Commit 7181250

Browse files
committed
feat(docs): serve static for docs
1 parent 762732e commit 7181250

File tree

4 files changed

+17
-4
lines changed

4 files changed

+17
-4
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,8 @@
1+
# 接口文档
2+
13
接口文档请查看 [docs/README.md](docs/README.md)
24

5+
6+
# 文档预览
7+
8+
![图片](docs/images/docs.png)

covid19/urls.py

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,17 @@
1919
from django.conf import settings
2020
from django.conf.urls import url
2121

22+
import os
23+
2224
urlpatterns = [
2325
path('admin/', admin.site.urls),
2426
path('api/', include('ncovapi.urls', namespace='ncovapi')),
25-
url(r'^static/(?P<path>.*)$', serve,{'document_root': settings.STATIC_ROOT}),
26-
]
27+
url(r'^static/(?P<path>.*)$', serve, {'document_root': settings.STATIC_ROOT}),
28+
url(r'^docs/$', serve, {
29+
'document_root': os.path.join(settings.BASE_DIR, 'docs'),
30+
'path': 'index.html'
31+
}),
32+
url(r'^docs/(?P<path>.*)$', serve, {
33+
'document_root': os.path.join(settings.BASE_DIR, 'docs')
34+
})
35+
]

docs/images/docs.png

111 KB
Loading

docs/index.html

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@
1111
</head>
1212
<body>
1313
<div id="app"></div>
14-
1514
<script>
1615
window.$docsify = {
1716
name: '新冠肺炎实时接口',
@@ -20,7 +19,6 @@
2019
</script>
2120
<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
2221
<script src="//cdn.jsdelivr.net/npm/docsify-copy-code"></script>
23-
<script src="//cdn.jsdelivr.net/npm/prismjs/components/prism-shell.min.js"></script>
2422
<script src="//cdn.jsdelivr.net/npm/prismjs/components/prism-python.min.js"></script>
2523
<script src="//cdn.jsdelivr.net/npm/prismjs/components/prism-json.min.js"></script>
2624
</body>

0 commit comments

Comments
 (0)