{"id":49206,"date":"2023-07-10T02:06:45","date_gmt":"2023-07-08T10:12:07","guid":{"rendered":"https:\/\/www.silicloud.com\/zh\/blog\/django-github-actions-%e4%bd%bf%e7%94%a8pdoc%e5%b0%86%e6%96%87%e6%a1%a3%e4%b8%8a%e4%bc%a0%e5%88%b0github-pages%ef%bc%81\/"},"modified":"2024-04-30T12:47:58","modified_gmt":"2024-04-30T04:47:58","slug":"django-github-actions-%e4%bd%bf%e7%94%a8pdoc%e5%b0%86%e6%96%87%e6%a1%a3%e4%b8%8a%e4%bc%a0%e5%88%b0github-pages%ef%bc%81","status":"publish","type":"post","link":"https:\/\/www.silicloud.com\/zh\/blog\/django-github-actions-%e4%bd%bf%e7%94%a8pdoc%e5%b0%86%e6%96%87%e6%a1%a3%e4%b8%8a%e4%bc%a0%e5%88%b0github-pages%ef%bc%81\/","title":{"rendered":"[Django + GitHub Actions] \u4f7f\u7528pdoc\u5c06\u6587\u6863\u4e0a\u4f20\u5230GitHub Pages\uff01"},"content":{"rendered":"<h2>\u603b\u7ed3<\/h2>\n<p>\u4f7f\u7528pdoc\u53ef\u4ee5\u5c06\u7528Python\u7f16\u5199\u7684\u6e90\u4ee3\u7801\u8fdb\u884c\u6587\u6863\u5316\u3002<br \/>\n\u6b64\u5916\uff0c\u8fd8\u53ef\u4ee5\u4f7f\u7528GitHub Actions\u548cGitHub Pages\u5c06\u6587\u6863\u4f5c\u4e3a\u7f51\u7ad9\u53d1\u5e03\u5230\u5b58\u50a8\u5e93\u4e2d\u3002<br \/>\n\u8fd9\u6b21\u5c06\u4ece\u4f7f\u7528pdoc\u5c06Django\u9879\u76ee\u5185\u7684\u6d4b\u8bd5\u4ee3\u7801\u8f93\u51fa\u4e3a\u5355\u5143\u6d4b\u8bd5\u89c4\u8303\u4e66\uff0c\u5230\u4f7f\u7528GitHub Actions\u53d1\u5e03\u89c4\u8303\u4e66\u7684\u65b9\u6cd5\u8fdb\u884c\u89e3\u91ca\u3002<br \/>\n\u867d\u7136\u91cf\u6bd4\u8f83\u5927\u4e14\u5185\u5bb9\u7a0d\u5fae\u6709\u96be\u5ea6\uff0c\u4f46\u8ba9\u6211\u4eec\u4e00\u8d77\u52aa\u529b\u5427\u3002<\/p>\n<h2>\u9996\u5148<\/h2>\n<ul class=\"post-ul\">\n<li style=\"list-style-type: none;\">\n<ul class=\"post-ul\">\u4eca\u56de\u306e\u30d7\u30ed\u30b8\u30a7\u30af\u30c8\u3067\u306fPoetry\u3068Postgres\u3092\u4f7f\u7528<\/ul>\n<\/li>\n<\/ul>\n<p>&nbsp;<\/p>\n<ul class=\"post-ul\">\n<li style=\"list-style-type: none;\">\n<ul class=\"post-ul\">Python\u306e\u30d0\u30fc\u30b8\u30e7\u30f3\u306f3.11\u3092\u4f7f\u7528<\/ul>\n<\/li>\n<\/ul>\n<p>&nbsp;<\/p>\n<ul class=\"post-ul\">\n<li style=\"list-style-type: none;\">\n<ul class=\"post-ul\">\u30c6\u30b9\u30c8\u30d5\u30ec\u30fc\u30e0\u30ef\u30fc\u30af\u306fPytest\u3092\u4f7f\u7528<\/ul>\n<\/li>\n<\/ul>\n<p>&nbsp;<\/p>\n<ul class=\"post-ul\">\n<li style=\"list-style-type: none;\">\n<ul class=\"post-ul\">\u30c6\u30b9\u30c8\u30b3\u30fc\u30c9\u3092\u4f5c\u6210\u6e08\u307f\u304a\u3088\u3073docstring\u3092\u8a18\u8f09\u6e08\u307f<\/ul>\n<\/li>\n<\/ul>\n<p>&nbsp;<\/p>\n<ul class=\"post-ul\">Django\u306e\u30d7\u30ed\u30b8\u30a7\u30af\u30c8\u3092\u4f5c\u6210\u6e08\u307f<\/ul>\n<h2>\u6587\u4ef6\u67b6\u6784<\/h2>\n<p>\u6587\u4ef6\u7ed3\u6784\u5982\u4e0b\u6240\u793a\uff1a<br \/>\n\u672c\u6b21\u5c06\u5728application\u6587\u4ef6\u5939\u4e2d\u5b58\u50a8Django\u9879\u76ee\u3002<br \/>\nDjango\u9879\u76ee\u7684\u540d\u79f0\u4e3aproject\uff0c\u5e94\u7528\u7a0b\u5e8f\u540d\u79f0\u4e3aapplication\u3002<\/p>\n<pre class=\"post-pre\"><code>tree\r\n\u30fb\r\n\u251c\u2500\u2500 .github\r\n\u2502   \u2514\u2500\u2500 workflows\r\n\u2502       \u2514\u2500\u2500 docs.yml\r\n\u251c\u2500\u2500 .gitignore\r\n\u2514\u2500\u2500 application\r\n    \u251c\u2500\u2500 application\r\n    \u2502   \u251c\u2500\u2500 __init__.py\r\n    \u2502   \u251c\u2500\u2500 admin.py\r\n    \u2502   \u251c\u2500\u2500 apps.py\r\n    \u2502   \u251c\u2500\u2500 migrations\r\n    \u2502   \u251c\u2500\u2500 models.py\r\n    \u2502   \u251c\u2500\u2500 tests\r\n    \u2502   \u251c\u2500\u2500 urls.py\r\n    \u2502   \u2514\u2500\u2500 views.py\r\n    \u251c\u2500\u2500 manage.py\r\n    \u251c\u2500\u2500 poetry.lock\r\n    \u251c\u2500\u2500 project\r\n    \u2502   \u251c\u2500\u2500 __init__.py\r\n    \u2502   \u251c\u2500\u2500 asgi.py\r\n    \u2502   \u251c\u2500\u2500 settings.py\r\n    \u2502   \u251c\u2500\u2500 urls\r\n    \u2502   \u2514\u2500\u2500 wsgi.py\r\n    \u2514\u2500\u2500 pyproject.toml\r\n<\/code><\/pre>\n<h2>\u8fd9\u4e2a\u6587\u4ef6\u6211\u4eec\u5c06\u5236\u4f5c<\/h2>\n<p>\u672c\u6b21\u8981\u5236\u4f5c\u7684\u6587\u4ef6\u5982\u4e0b\u6240\u793a\u3002<\/p>\n<ul class=\"post-ul\">\n<li style=\"list-style-type: none;\">\n<ul class=\"post-ul\">application\/pyproject.toml<\/ul>\n<\/li>\n<\/ul>\n<p>&nbsp;<\/p>\n<ul class=\"post-ul\">\n<li style=\"list-style-type: none;\">\n<ul class=\"post-ul\">application\/application\/__init__.py<\/ul>\n<\/li>\n<\/ul>\n<p>&nbsp;<\/p>\n<ul class=\"post-ul\">\n<li style=\"list-style-type: none;\">\n<ul class=\"post-ul\">.gitignore<\/ul>\n<\/li>\n<\/ul>\n<p>&nbsp;<\/p>\n<ul class=\"post-ul\">.github\/workflow\/docs.yml<\/ul>\n<h2>\u5e94\u7528\u7a0b\u5e8f\/ pyproject.toml<\/h2>\n<p>\u521b\u5efa pyproject.toml \u6587\u4ef6<br \/>\n\u8fd9\u6b21<\/p>\n<ul class=\"post-ul\">\n<li style=\"list-style-type: none;\">\n<ul class=\"post-ul\">Python<\/ul>\n<\/li>\n<\/ul>\n<p>&nbsp;<\/p>\n<ul class=\"post-ul\">\n<li style=\"list-style-type: none;\">\n<ul class=\"post-ul\">Django<\/ul>\n<\/li>\n<\/ul>\n<p>&nbsp;<\/p>\n<ul class=\"post-ul\">\n<li style=\"list-style-type: none;\">\n<ul class=\"post-ul\">Postgres<\/ul>\n<\/li>\n<\/ul>\n<p>&nbsp;<\/p>\n<ul class=\"post-ul\">\n<li style=\"list-style-type: none;\">\n<ul class=\"post-ul\">Pytest<\/ul>\n<\/li>\n<\/ul>\n<p>&nbsp;<\/p>\n<ul class=\"post-ul\">Pdoc<\/ul>\n<p>\u5b89\u88c5\u5305\u3002<\/p>\n<pre class=\"post-pre\"><code><span class=\"nn\">[tool.poetry]<\/span>\r\n<span class=\"py\">name<\/span> <span class=\"p\">=<\/span> <span class=\"s\">\"api\"<\/span>\r\n<span class=\"py\">version<\/span> <span class=\"p\">=<\/span> <span class=\"s\">\"0.1.0\"<\/span>\r\n<span class=\"py\">description<\/span> <span class=\"p\">=<\/span> <span class=\"s\">\"api\"<\/span>\r\n<span class=\"py\">authors<\/span> <span class=\"p\">=<\/span> <span class=\"p\">[<\/span><span class=\"s\">\"shun198\"<\/span><span class=\"p\">]<\/span>\r\n<span class=\"py\">readme<\/span> <span class=\"p\">=<\/span> <span class=\"s\">\"README.md\"<\/span>\r\n\r\n<span class=\"nn\">[tool.poetry.dependencies]<\/span>\r\n<span class=\"py\">python<\/span> <span class=\"p\">=<\/span> <span class=\"s\">\"^3.11\"<\/span>\r\n<span class=\"py\">Django<\/span> <span class=\"p\">=<\/span> <span class=\"s\">\"^4.1.2\"<\/span>\r\n<span class=\"py\">psycopg2<\/span> <span class=\"p\">=<\/span> <span class=\"s\">\"^2.9.6\"<\/span>\r\n\r\n<span class=\"nn\">[tool.poetry.group.dev.dependencies]<\/span>\r\n<span class=\"py\">pytest<\/span> <span class=\"p\">=<\/span> <span class=\"s\">\"^7.1.3\"<\/span>\r\n<span class=\"py\">pytest-django<\/span> <span class=\"p\">=<\/span> <span class=\"s\">\"^4.5.2\"<\/span>\r\n<span class=\"py\">pdoc<\/span> <span class=\"p\">=<\/span> <span class=\"s\">\"^13.0.0\"<\/span>\r\n<\/code><\/pre>\n<p>\u5982\u679c\u60a8\u60f3\u8be6\u7ec6\u4e86\u89e3Poetry\u7684\u4f7f\u7528\u65b9\u6cd5\uff0c\u8bf7\u53c2\u8003\u4ee5\u4e0b\u6587\u7ae0\u3002<\/p>\n<p>&nbsp;<\/p>\n<h2>\u4e3a\u4ec0\u4e48\u65e0\u6cd5\u5728Django\u4e0a\u8fd0\u884cpdoc\uff1f<\/h2>\n<p>\u5f53\u60a8\u9700\u8981\u751f\u6210Pdoc\u6587\u6863\u65f6\uff0c\u8bf7\u6267\u884c\u4ee5\u4e0b\u547d\u4ee4\u3002<\/p>\n<pre class=\"post-pre\"><code>poetry run pdoc -o docs application\/tests\r\n<\/code><\/pre>\n<p>\u6211\u8ba4\u4e3a\uff0c\u5f53\u4f60\u8fd0\u884c\u6b64\u547d\u4ee4\u65f6\uff0c\u539f\u672c\u5e94\u8be5\u5c06\u4f4d\u4e8eapplication\/tests\u6587\u4ef6\u5939\u5185\u7684\u6240\u6709\u6e90\u4ee3\u7801\u4ee5HTML\u683c\u5f0f\u8f93\u51fa\u5230docs\u6587\u4ef6\u5939\uff0c\u4f46\u662f\u4f30\u8ba1\u4f1a\u9047\u5230\u4ee5\u4e0b\u9519\u8bef\u8f93\u51fa\u3002<\/p>\n<pre class=\"post-pre\"><code>  File \"\/root\/.cache\/pypoetry\/virtualenvs\/api-MATOk_fk-py3.11\/lib\/python3.11\/site-packages\/django\/apps\/registry.py\", line 260, in get_containing_app_config\r\n    self.check_apps_ready()\r\n  File \"\/root\/.cache\/pypoetry\/virtualenvs\/api-MATOk_fk-py3.11\/lib\/python3.11\/site-packages\/django\/apps\/registry.py\", line 138, in check_apps_ready\r\n    raise AppRegistryNotReady(\"Apps aren't loaded yet.\")\r\ndjango.core.exceptions.AppRegistryNotReady: Apps aren't loaded yet.\r\n<\/code><\/pre>\n<p>\u53ea\u9700\u4e00\u4e2a\u65b9\u5f0f\uff0c\u539f\u6587\u662f\u9019\u6a23\u7684\uff1a\u5f53\u6267\u884cpdoc\u65f6\uff0c\u5728\u5185\u90e8\u542f\u52a8Django\u5e76\u8f93\u51fa\u7ed3\u679c\u3002\u4f46\u662f\uff0c\u8fd9\u6b21\u5728\u8f93\u51fatests\u6587\u4ef6\u5939\u5185\u7684\u6e90\u4ee3\u7801\u65f6\u5e76\u6ca1\u6709\u542f\u52a8Django\u3002<\/p>\n<pre class=\"post-pre\"><code>Apps aren't loaded yet\r\n<\/code><\/pre>\n<p>\u53ef\u80fd\u662f\u8868\u793a\u5728\u5c4f\u5e55\u4e0a<\/p>\n<h3>\u5bf9\u4e8e\u60f3\u66f4\u4e86\u89e3\u5c1a\u672a\u52a0\u8f7d\u7684\u5e94\u7528\u7684\u4eba\u58eb<\/h3>\n<p>\u8fd0\u884cDjango\u65f6\uff0c\u4f1a\u6267\u884casgi.py\uff08\u6216wsgi.py\uff09\u4e2d\u7684\u5185\u5bb9\u3002<\/p>\n<pre class=\"post-pre\"><code><span class=\"sh\">\"\"\"<\/span><span class=\"s\">\r\nASGI config for project project.\r\n\r\nIt exposes the ASGI callable as a module-level variable named ``application``.\r\n\r\nFor more information on this file, see\r\nhttps:\/\/docs.djangoproject.com\/en\/4.1\/howto\/deployment\/asgi\/\r\n<\/span><span class=\"sh\">\"\"\"<\/span>\r\n\r\n<span class=\"kn\">import<\/span> <span class=\"n\">os<\/span>\r\n\r\n<span class=\"kn\">from<\/span> <span class=\"n\">django.core.asgi<\/span> <span class=\"kn\">import<\/span> <span class=\"n\">get_asgi_application<\/span>\r\n\r\n<span class=\"n\">os<\/span><span class=\"p\">.<\/span><span class=\"n\">environ<\/span><span class=\"p\">.<\/span><span class=\"nf\">setdefault<\/span><span class=\"p\">(<\/span><span class=\"sh\">\"<\/span><span class=\"s\">DJANGO_SETTINGS_MODULE<\/span><span class=\"sh\">\"<\/span><span class=\"p\">,<\/span> <span class=\"sh\">\"<\/span><span class=\"s\">project.settings<\/span><span class=\"sh\">\"<\/span><span class=\"p\">)<\/span>\r\n\r\n<span class=\"n\">application<\/span> <span class=\"o\">=<\/span> <span class=\"nf\">get_asgi_application<\/span><span class=\"p\">()<\/span>\r\n<\/code><\/pre>\n<p>\u4e4b\u540e\u5c06\u8c03\u7528get_asgi_application()<\/p>\n<pre class=\"post-pre\"><code><span class=\"kn\">import<\/span> <span class=\"n\">django<\/span>\r\n<span class=\"kn\">from<\/span> <span class=\"n\">django.core.handlers.asgi<\/span> <span class=\"kn\">import<\/span> <span class=\"n\">ASGIHandler<\/span>\r\n\r\n\r\n<span class=\"k\">def<\/span> <span class=\"nf\">get_asgi_application<\/span><span class=\"p\">():<\/span>\r\n    <span class=\"sh\">\"\"\"<\/span><span class=\"s\">\r\n    The public interface to Django<\/span><span class=\"sh\">'<\/span><span class=\"s\">s ASGI support. Return an ASGI 3 callable.\r\n\r\n    Avoids making django.core.handlers.ASGIHandler a public API, in case the\r\n    internal implementation changes or moves in the future.\r\n    <\/span><span class=\"sh\">\"\"\"<\/span>\r\n    <span class=\"n\">django<\/span><span class=\"p\">.<\/span><span class=\"nf\">setup<\/span><span class=\"p\">(<\/span><span class=\"n\">set_prefix<\/span><span class=\"o\">=<\/span><span class=\"bp\">False<\/span><span class=\"p\">)<\/span>\r\n    <span class=\"k\">return<\/span> <span class=\"nc\">ASGIHandler<\/span><span class=\"p\">()<\/span>\r\n<\/code><\/pre>\n<p>setup() function is called in Django.<\/p>\n<ul class=\"post-ul\">\n<li style=\"list-style-type: none;\">\n<ul class=\"post-ul\">apps<\/ul>\n<\/li>\n<\/ul>\n<p>&nbsp;<\/p>\n<ul class=\"post-ul\">settings<\/ul>\n<p>\u53ea\u6709\u5f53\u5bfc\u5165\u4e86Django\u6240\u9700\u7684\u5305\u65f6\uff0c\u624d\u4f1a\u5bfc\u5165setup()\u65b9\u6cd5\u3002\u5982\u679c\u6ca1\u6709setup()\u65b9\u6cd5\uff0c\u5c06\u65e0\u6cd5\u5bfc\u5165apps\u6216settings\u3002<\/p>\n<pre class=\"post-pre\"><code>Apps aren't loaded yet\r\n<\/code><\/pre>\n<p>\u51fa\u73b0\u8fd9\u4e2a\u9519\u8bef\u662f\u56e0\u4e3a\u8fd9\u4e2a\u539f\u56e0\u3002<\/p>\n<pre class=\"post-pre\"><code><span class=\"kn\">from<\/span> <span class=\"n\">django.utils.version<\/span> <span class=\"kn\">import<\/span> <span class=\"n\">get_version<\/span>\r\n\r\n<span class=\"n\">VERSION<\/span> <span class=\"o\">=<\/span> <span class=\"p\">(<\/span><span class=\"mi\">4<\/span><span class=\"p\">,<\/span> <span class=\"mi\">0<\/span><span class=\"p\">,<\/span> <span class=\"mi\">6<\/span><span class=\"p\">,<\/span> <span class=\"sh\">\"<\/span><span class=\"s\">final<\/span><span class=\"sh\">\"<\/span><span class=\"p\">,<\/span> <span class=\"mi\">0<\/span><span class=\"p\">)<\/span>\r\n\r\n<span class=\"n\">__version__<\/span> <span class=\"o\">=<\/span> <span class=\"nf\">get_version<\/span><span class=\"p\">(<\/span><span class=\"n\">VERSION<\/span><span class=\"p\">)<\/span>\r\n\r\n\r\n<span class=\"k\">def<\/span> <span class=\"nf\">setup<\/span><span class=\"p\">(<\/span><span class=\"n\">set_prefix<\/span><span class=\"o\">=<\/span><span class=\"bp\">True<\/span><span class=\"p\">):<\/span>\r\n    <span class=\"sh\">\"\"\"<\/span><span class=\"s\">\r\n    Configure the settings (this happens as a side effect of accessing the\r\n    first setting), configure logging and populate the app registry.\r\n    Set the thread-local urlresolvers script prefix if `set_prefix` is True.\r\n    <\/span><span class=\"sh\">\"\"\"<\/span>\r\n    <span class=\"kn\">from<\/span> <span class=\"n\">django.apps<\/span> <span class=\"kn\">import<\/span> <span class=\"n\">apps<\/span>\r\n    <span class=\"kn\">from<\/span> <span class=\"n\">django.conf<\/span> <span class=\"kn\">import<\/span> <span class=\"n\">settings<\/span>\r\n    <span class=\"kn\">from<\/span> <span class=\"n\">django.urls<\/span> <span class=\"kn\">import<\/span> <span class=\"n\">set_script_prefix<\/span>\r\n    <span class=\"kn\">from<\/span> <span class=\"n\">django.utils.log<\/span> <span class=\"kn\">import<\/span> <span class=\"n\">configure_logging<\/span>\r\n\r\n    <span class=\"nf\">configure_logging<\/span><span class=\"p\">(<\/span><span class=\"n\">settings<\/span><span class=\"p\">.<\/span><span class=\"n\">LOGGING_CONFIG<\/span><span class=\"p\">,<\/span> <span class=\"n\">settings<\/span><span class=\"p\">.<\/span><span class=\"n\">LOGGING<\/span><span class=\"p\">)<\/span>\r\n    <span class=\"k\">if<\/span> <span class=\"n\">set_prefix<\/span><span class=\"p\">:<\/span>\r\n        <span class=\"nf\">set_script_prefix<\/span><span class=\"p\">(<\/span>\r\n            <span class=\"sh\">\"<\/span><span class=\"s\">\/<\/span><span class=\"sh\">\"<\/span> <span class=\"k\">if<\/span> <span class=\"n\">settings<\/span><span class=\"p\">.<\/span><span class=\"n\">FORCE_SCRIPT_NAME<\/span> <span class=\"ow\">is<\/span> <span class=\"bp\">None<\/span> <span class=\"k\">else<\/span> <span class=\"n\">settings<\/span><span class=\"p\">.<\/span><span class=\"n\">FORCE_SCRIPT_NAME<\/span>\r\n        <span class=\"p\">)<\/span>\r\n    <span class=\"n\">apps<\/span><span class=\"p\">.<\/span><span class=\"nf\">populate<\/span><span class=\"p\">(<\/span><span class=\"n\">settings<\/span><span class=\"p\">.<\/span><span class=\"n\">INSTALLED_APPS<\/span><span class=\"p\">)<\/span>\r\n<\/code><\/pre>\n<p>\u6362\u53e5\u8bdd\u8bf4\uff0c\u5f53\u6267\u884cpdoc\u65f6\uff0c\u5fc5\u987b\u5148\u6267\u884csetup\u65b9\u6cd5\u3002<\/p>\n<h2>\u5904\u7406\u65b9\u6cd5<\/h2>\n<p>\u5728\u6267\u884cdjango.setup()\u4e4b\u524d\uff0c\u53ef\u4ee5\u5728\u60f3\u8981\u8f93\u51fa\u7684\u6587\u4ef6\u5939\uff08\u4f8b\u5982application\/tests\uff09\u7684__init__.py\u6587\u4ef6\u4e2d\u6dfb\u52a0django.setup()\u3002\u7531\u4e8edjango.setup()\u4e5f\u4f1a\u5728\u9879\u76ee\u5185\u6267\u884c\uff0c\u56e0\u6b64\u5982\u679c\u5c1d\u8bd5\u542f\u52a8Django\uff0c\u53ef\u80fd\u4f1a\u53d1\u751f\u4e0edjango.setup()\u51b2\u7a81\u65e0\u6cd5\u542f\u52a8\u7684\u60c5\u51b5\u3002\u56e0\u6b64\uff0c\u6211\u4eec\u53ef\u4ee5\u901a\u8fc7\u5224\u65ad\u662f\u5426\u5b58\u5728\u540d\u4e3aCI_MAKING_DOCS\u7684\u73af\u5883\u53d8\u91cf\u6765\u907f\u514d\u51b2\u7a81\u3002<\/p>\n<pre class=\"post-pre\"><code><span class=\"kn\">import<\/span> <span class=\"n\">os<\/span>\r\n\r\n<span class=\"k\">if<\/span> <span class=\"n\">os<\/span><span class=\"p\">.<\/span><span class=\"n\">environ<\/span><span class=\"p\">.<\/span><span class=\"nf\">get<\/span><span class=\"p\">(<\/span><span class=\"sh\">\"<\/span><span class=\"s\">CI_MAKING_DOCS<\/span><span class=\"sh\">\"<\/span><span class=\"p\">)<\/span> <span class=\"ow\">is<\/span> <span class=\"ow\">not<\/span> <span class=\"bp\">None<\/span><span class=\"p\">:<\/span>\r\n    <span class=\"sh\">\"\"\"<\/span><span class=\"s\">\u30c6\u30b9\u30c8\u4ed5\u69d8\u66f8\u3092pdoc\u3067\u51fa\u529b\u3059\u308b\u305f\u3081\u306bdjango.setup\u3092\u5b9f\u65bd\u3059\u308b<\/span><span class=\"sh\">\"\"\"<\/span>\r\n    <span class=\"kn\">import<\/span> <span class=\"n\">django<\/span>\r\n\r\n    <span class=\"n\">django<\/span><span class=\"p\">.<\/span><span class=\"nf\">setup<\/span><span class=\"p\">()<\/span>\r\n<\/code><\/pre>\n<h3>\u6267\u884cpdoc\u7684\u547d\u4ee4<\/h3>\n<p>\u901a\u8fc7\u5c06\u503c\u4f20\u9012\u7ed9\u540d\u4e3aCI_MAKING_DOCS\u7684\u73af\u5883\u53d8\u91cf\uff0c\u5728Poetry\u8fd0\u884c\u65f6\uff0c\u5c06\u6267\u884cdjango.setup()\u3002<\/p>\n<pre class=\"post-pre\"><code>CI_MAKING_DOCS=1 poetry run pdoc -o docs application\/tests\/\r\n<\/code><\/pre>\n<p>\u5982\u679c\u60a8\u4f7f\u7528docker-compose\uff0c\u8bf7\u6267\u884c\u4ee5\u4e0b\u547d\u4ee4\u3002<\/p>\n<pre class=\"post-pre\"><code>docker-compose exec app env CI_MAKING_DOCS=1 poetry run pdoc -o docs application\/tests\/\r\n<\/code><\/pre>\n<p>\u5982\u679c\u521b\u5efa\u4e86\u4e00\u4e2a\u540d\u4e3a\u201cdocs\u201d\u7684\u6587\u4ef6\u5939\uff0c\u90a3\u5c31\u662f\u6210\u529f\u4e86\u3002<\/p>\n<div><img decoding=\"async\" class=\"post-images\" title=\"\" src=\"https:\/\/cdn.silicloud.com\/blog-img\/blog\/img\/657d8a33913a08637a6c8d02\/46-0.png\" alt=\"\u30b9\u30af\u30ea\u30fc\u30f3\u30b7\u30e7\u30c3\u30c8 2023-06-10 11.49.13.png\" \/><\/div>\n<h2>.gitignore \u6587\u4ef6<\/h2>\n<p>\u5c06docs\u6587\u4ef6\u5939\u6dfb\u52a0\u5230.gitignore\u4e2d\uff0c\u56e0\u4e3a\u4e0d\u9700\u8981\u5bf9\u5176\u8fdb\u884c\u7248\u672c\u63a7\u5236\u3002<\/p>\n<pre class=\"post-pre\"><code>docs\/\r\n<\/code><\/pre>\n<h2>GitHub Pages\u7684\u8bbe\u7f6e<\/h2>\n<p>\u5728\u521b\u5efa\u5de5\u4f5c\u6d41\u4e4b\u524d\uff0c\u6211\u4eec\u9700\u8981\u8fdb\u884cGitHub Pages\u7684\u8bbe\u7f6e\u3002\u5728\u6253\u5f00&#8221;\u8bbe\u7f6e&#8221;\u9875\u9762\u540e\uff0c\u5c06&#8221;\u6e90&#8221;\u8bbe\u4e3a&#8221;GitHub Actions&#8221;\u3002<\/p>\n<div><img decoding=\"async\" class=\"post-images\" title=\"\" src=\"https:\/\/cdn.silicloud.com\/blog-img\/blog\/img\/657d8a33913a08637a6c8d02\/52-0.png\" alt=\"\u30b9\u30af\u30ea\u30fc\u30f3\u30b7\u30e7\u30c3\u30c8 2023-06-10 14.42.18.png\" \/><\/div>\n<h2>\u521b\u5efa\u5de5\u4f5c\u6d41\u7a0b (Create a workflow)<\/h2>\n<p>\u63a5\u4e0b\u6765\uff0c\u6211\u5c06\u89e3\u91ca\u5982\u4f55\u521b\u5efa\u4e00\u4e2a\u5de5\u4f5c\u6d41\uff0c\u5c06\u901a\u8fc7pdoc\u5bfc\u51fa\u7684\u6587\u6863\u4e0a\u4f20\u5230GitHub Pages\u3002\u8fd9\u91cc\u7684\u5de5\u4f5c\u6d41\u662f\u6839\u636epdoc\u5b98\u65b9\u63d0\u4f9b\u7684\u5de5\u4f5c\u6d41\u8fdb\u884c\u521b\u5efa\u7684\uff0c\u4f46\u7531\u4e8e\u4f7f\u7528\u4e86Poetry\u7b49\u7a0d\u6709\u4e0d\u540c\u4e4b\u5904\uff0c\u6211\u5c06\u8fdb\u884c\u89e3\u91ca\u8bf4\u660e\u3002<\/p>\n<p>&nbsp;<\/p>\n<pre class=\"post-pre\"><code><span class=\"na\">name<\/span><span class=\"pi\">:<\/span> <span class=\"s\">GitHub Pages<\/span>\r\n<span class=\"na\">on<\/span><span class=\"pi\">:<\/span>\r\n  <span class=\"na\">push<\/span><span class=\"pi\">:<\/span>\r\n    <span class=\"na\">branches<\/span><span class=\"pi\">:<\/span>\r\n      <span class=\"pi\">-<\/span> <span class=\"s\">develop<\/span>\r\n\r\n<span class=\"c1\"># security: restrict permissions for CI jobs.<\/span>\r\n<span class=\"na\">permissions<\/span><span class=\"pi\">:<\/span>\r\n  <span class=\"na\">contents<\/span><span class=\"pi\">:<\/span> <span class=\"s\">read<\/span>\r\n\r\n<span class=\"na\">env<\/span><span class=\"pi\">:<\/span>\r\n  <span class=\"na\">SECRET_KEY<\/span><span class=\"pi\">:<\/span> <span class=\"s\">test<\/span>\r\n  <span class=\"na\">DJANGO_SETTINGS_MODULE<\/span><span class=\"pi\">:<\/span> <span class=\"s\">project.settings<\/span>\r\n  <span class=\"na\">ALLOWED_HOSTS<\/span><span class=\"pi\">:<\/span> <span class=\"s\">127.0.0.1<\/span>\r\n  <span class=\"na\">POSTGRES_NAME<\/span><span class=\"pi\">:<\/span> <span class=\"s\">test<\/span>\r\n  <span class=\"na\">POSTGRES_USER<\/span><span class=\"pi\">:<\/span> <span class=\"s\">test<\/span>\r\n  <span class=\"na\">POSTGRES_PASSWORD<\/span><span class=\"pi\">:<\/span> <span class=\"s\">test<\/span>\r\n  <span class=\"na\">POSTGRES_HOST<\/span><span class=\"pi\">:<\/span> <span class=\"s\">127.0.0.1<\/span>\r\n  <span class=\"na\">POSTGRES_PORT<\/span><span class=\"pi\">:<\/span> <span class=\"m\">5432<\/span>\r\n  <span class=\"na\">CI_MAKING_DOCS<\/span><span class=\"pi\">:<\/span> <span class=\"m\">1<\/span>\r\n\r\n<span class=\"na\">jobs<\/span><span class=\"pi\">:<\/span>\r\n  <span class=\"c1\"># Build the documentation and upload the static HTML files as an artifact.<\/span>\r\n  <span class=\"na\">build<\/span><span class=\"pi\">:<\/span>\r\n    <span class=\"na\">runs-on<\/span><span class=\"pi\">:<\/span> <span class=\"s\">ubuntu-latest<\/span>\r\n    <span class=\"na\">defaults<\/span><span class=\"pi\">:<\/span>\r\n      <span class=\"na\">run<\/span><span class=\"pi\">:<\/span>\r\n        <span class=\"na\">working-directory<\/span><span class=\"pi\">:<\/span> <span class=\"s\">application<\/span>\r\n    <span class=\"na\">steps<\/span><span class=\"pi\">:<\/span>\r\n      <span class=\"pi\">-<\/span> <span class=\"na\">name<\/span><span class=\"pi\">:<\/span> <span class=\"s\">Chekcout code<\/span>\r\n        <span class=\"na\">uses<\/span><span class=\"pi\">:<\/span> <span class=\"s\">actions\/checkout@v3<\/span>\r\n      <span class=\"pi\">-<\/span> <span class=\"na\">name<\/span><span class=\"pi\">:<\/span> <span class=\"s\">Install poetry<\/span>\r\n        <span class=\"na\">run<\/span><span class=\"pi\">:<\/span> <span class=\"s\">pipx install poetry<\/span>\r\n      <span class=\"pi\">-<\/span> <span class=\"na\">name<\/span><span class=\"pi\">:<\/span> <span class=\"s\">Use cache dependencies<\/span>\r\n        <span class=\"na\">uses<\/span><span class=\"pi\">:<\/span> <span class=\"s\">actions\/setup-python@v4<\/span>\r\n        <span class=\"na\">with<\/span><span class=\"pi\">:<\/span>\r\n          <span class=\"na\">python-version<\/span><span class=\"pi\">:<\/span> <span class=\"s1\">'<\/span><span class=\"s\">3.11'<\/span>\r\n          <span class=\"na\">cache<\/span><span class=\"pi\">:<\/span> <span class=\"s1\">'<\/span><span class=\"s\">poetry'<\/span>\r\n      <span class=\"pi\">-<\/span> <span class=\"na\">name<\/span><span class=\"pi\">:<\/span> <span class=\"s\">Install Packages<\/span>\r\n        <span class=\"na\">run<\/span><span class=\"pi\">:<\/span> <span class=\"s\">poetry install<\/span>\r\n      <span class=\"pi\">-<\/span> <span class=\"na\">name<\/span><span class=\"pi\">:<\/span> <span class=\"s\">Create documentation<\/span>\r\n        <span class=\"na\">run<\/span><span class=\"pi\">:<\/span> <span class=\"s\">poetry run pdoc -o docs application\/tests\/<\/span>\r\n      <span class=\"pi\">-<\/span> <span class=\"na\">name<\/span><span class=\"pi\">:<\/span> <span class=\"s\">Upload Documents<\/span>\r\n        <span class=\"na\">uses<\/span><span class=\"pi\">:<\/span> <span class=\"s\">actions\/upload-pages-artifact@v1<\/span>\r\n        <span class=\"na\">with<\/span><span class=\"pi\">:<\/span>\r\n          <span class=\"c1\"># \u7d76\u5bfe\u30d1\u30b9\u3092\u6307\u5b9a<\/span>\r\n          <span class=\"na\">path<\/span><span class=\"pi\">:<\/span> <span class=\"s\">application\/docs\/<\/span>\r\n\r\n  <span class=\"c1\"># Deploy the artifact to GitHub pages.<\/span>\r\n  <span class=\"c1\"># This is a separate job so that only actions\/deploy-pages has the necessary permissions.<\/span>\r\n  <span class=\"na\">deploy<\/span><span class=\"pi\">:<\/span>\r\n    <span class=\"na\">needs<\/span><span class=\"pi\">:<\/span> <span class=\"s\">build<\/span>\r\n    <span class=\"na\">runs-on<\/span><span class=\"pi\">:<\/span> <span class=\"s\">ubuntu-latest<\/span>\r\n    <span class=\"na\">permissions<\/span><span class=\"pi\">:<\/span>\r\n      <span class=\"na\">pages<\/span><span class=\"pi\">:<\/span> <span class=\"s\">write<\/span>\r\n      <span class=\"na\">id-token<\/span><span class=\"pi\">:<\/span> <span class=\"s\">write<\/span>\r\n    <span class=\"na\">environment<\/span><span class=\"pi\">:<\/span>\r\n      <span class=\"na\">name<\/span><span class=\"pi\">:<\/span> <span class=\"s\">github-pages<\/span>\r\n      <span class=\"na\">url<\/span><span class=\"pi\">:<\/span> <span class=\"s\">${{ steps.deployment.outputs.page_url }}<\/span>\r\n    <span class=\"na\">steps<\/span><span class=\"pi\">:<\/span>\r\n      <span class=\"pi\">-<\/span> <span class=\"na\">id<\/span><span class=\"pi\">:<\/span> <span class=\"s\">deployment<\/span>\r\n        <span class=\"na\">uses<\/span><span class=\"pi\">:<\/span> <span class=\"s\">actions\/deploy-pages@v2<\/span>\r\n<\/code><\/pre>\n<h3>\u5728\u6267\u884c\u65f6\u6307\u5b9a\u5206\u652f<\/h3>\n<p>\u6211\u5011\u5c07\u78ba\u4fdd\u5728\u672c\u6b21\u958b\u767c\u5206\u652f\u548c\u529f\u80fd\u5206\u652f\u5408\u4f75\u6216\u63a8\u9001\u5230develop\u5206\u652f\u6642\uff0c\u5de5\u4f5c\u6d41\u7a0b\u5c07\u88ab\u57f7\u884c\u3002<\/p>\n<pre class=\"post-pre\"><code><span class=\"na\">name<\/span><span class=\"pi\">:<\/span> <span class=\"s\">GitHub Pages<\/span>\r\n<span class=\"na\">on<\/span><span class=\"pi\">:<\/span>\r\n  <span class=\"na\">push<\/span><span class=\"pi\">:<\/span>\r\n    <span class=\"na\">branches<\/span><span class=\"pi\">:<\/span>\r\n      <span class=\"pi\">-<\/span> <span class=\"s\">develop<\/span>\r\n<\/code><\/pre>\n<h3>\u73af\u5883\u53d8\u91cf<\/h3>\n<p>\u7531\u4e8e\u8fd9\u6b21\u6211\u6b63\u5728\u4f7f\u7528Postgres\uff0c\u6240\u4ee5\u5728\u4f7f\u7528\u6570\u636e\u5e93\u65f6\uff0c\u8bf7\u6307\u5b9a\u6570\u636e\u5e93\u7684\u73af\u5883\u53d8\u91cf\u3002<br \/>\n\u8fd8\u8bf7\u6307\u5b9a\u542f\u52a8Django\u6240\u9700\u7684\u73af\u5883\u53d8\u91cf\uff0c\u5305\u62ecSECRET_KEY\u3002<br \/>\n\u5728\u4f7f\u7528pdoc\u65f6\uff0c\u4e5f\u9700\u8981\u63d0\u4f9bCI_MAKING_DOCS\u73af\u5883\u53d8\u91cf\u3002<\/p>\n<pre class=\"post-pre\"><code><span class=\"na\">env<\/span><span class=\"pi\">:<\/span>\r\n  <span class=\"na\">SECRET_KEY<\/span><span class=\"pi\">:<\/span> <span class=\"s\">test<\/span>\r\n  <span class=\"na\">DJANGO_SETTINGS_MODULE<\/span><span class=\"pi\">:<\/span> <span class=\"s\">project.settings<\/span>\r\n  <span class=\"na\">ALLOWED_HOSTS<\/span><span class=\"pi\">:<\/span> <span class=\"s\">127.0.0.1<\/span>\r\n  <span class=\"na\">POSTGRES_NAME<\/span><span class=\"pi\">:<\/span> <span class=\"s\">test<\/span>\r\n  <span class=\"na\">POSTGRES_USER<\/span><span class=\"pi\">:<\/span> <span class=\"s\">test<\/span>\r\n  <span class=\"na\">POSTGRES_PASSWORD<\/span><span class=\"pi\">:<\/span> <span class=\"s\">test<\/span>\r\n  <span class=\"na\">POSTGRES_HOST<\/span><span class=\"pi\">:<\/span> <span class=\"s\">127.0.0.1<\/span>\r\n  <span class=\"na\">POSTGRES_PORT<\/span><span class=\"pi\">:<\/span> <span class=\"m\">5432<\/span>\r\n  <span class=\"na\">CI_MAKING_DOCS<\/span><span class=\"pi\">:<\/span> <span class=\"m\">1<\/span>\r\n<\/code><\/pre>\n<h3>\u4f7f\u7528\u8bd7\u6b4c\u5b9e\u65bd\u7684PDOC\u6267\u884c<\/h3>\n<p>\u5982\u679c\u4f60\u60f3\u8981\u4e86\u89e3\u6709\u5173Poetry\u7f13\u5b58\u7684\u4f7f\u7528\u65b9\u6cd5\u4ee5\u53ca\u5176\u4ed6\u8be6\u7ec6\u4fe1\u606f\uff0c\u8bf7\u53c2\u8003\u4ee5\u4e0b\u6587\u7ae0\uff0c\u56e0\u4e3a\u8fd9\u6b21\u6211\u4eec\u4f7f\u7528\u4e86Poetry\u6765\u5b9e\u73b0\u5b89\u88c5\u7684\u52a0\u901f\uff0c\u5e76\u5229\u7528Poetry\u7684\u8bbe\u7f6e\u548c\u7f13\u5b58\u6765\u52a0\u5feb\u7b2c\u4e8c\u6b21\u53ca\u4ee5\u540e\u7684\u5b89\u88c5\u901f\u5ea6\u3002<\/p>\n<p>&nbsp;<\/p>\n<p>\u6b64\u5916\uff0c\u5728\u4f7f\u7528actions\/upload-pages-artifact@v1\u65f6\uff0c\u8bf7\u5c06docs\u6587\u4ef6\u5939\u7684\u8def\u5f84\u8bbe\u7f6e\u4e3a\u7edd\u5bf9\u8def\u5f84\u3002\u901a\u8fc7\u4f7f\u7528\u5b98\u65b9\u63d0\u4f9b\u7684\u8fd9\u4e2aaction\uff0cdocs\u6587\u4ef6\u5939\u4e2d\u7684\u6587\u4ef6\u5c06\u88ab\u4fdd\u5b58\u4e3aartifact\u5728GitHub Actions\u5185\uff0c\u5e76\u4e14\u53ef\u4ee5\u4e0a\u4f20\u5230GitHub Pages\u3002<\/p>\n<pre class=\"post-pre\"><code><span class=\"na\">jobs<\/span><span class=\"pi\">:<\/span>\r\n  <span class=\"c1\"># Build the documentation and upload the static HTML files as an artifact.<\/span>\r\n  <span class=\"na\">build<\/span><span class=\"pi\">:<\/span>\r\n    <span class=\"na\">runs-on<\/span><span class=\"pi\">:<\/span> <span class=\"s\">ubuntu-latest<\/span>\r\n    <span class=\"na\">defaults<\/span><span class=\"pi\">:<\/span>\r\n      <span class=\"na\">run<\/span><span class=\"pi\">:<\/span>\r\n        <span class=\"na\">working-directory<\/span><span class=\"pi\">:<\/span> <span class=\"s\">application<\/span>\r\n    <span class=\"na\">steps<\/span><span class=\"pi\">:<\/span>\r\n      <span class=\"pi\">-<\/span> <span class=\"na\">name<\/span><span class=\"pi\">:<\/span> <span class=\"s\">Chekcout code<\/span>\r\n        <span class=\"na\">uses<\/span><span class=\"pi\">:<\/span> <span class=\"s\">actions\/checkout@v3<\/span>\r\n      <span class=\"pi\">-<\/span> <span class=\"na\">name<\/span><span class=\"pi\">:<\/span> <span class=\"s\">Install poetry<\/span>\r\n        <span class=\"na\">run<\/span><span class=\"pi\">:<\/span> <span class=\"s\">pipx install poetry<\/span>\r\n      <span class=\"pi\">-<\/span> <span class=\"na\">name<\/span><span class=\"pi\">:<\/span> <span class=\"s\">Use cache dependencies<\/span>\r\n        <span class=\"na\">uses<\/span><span class=\"pi\">:<\/span> <span class=\"s\">actions\/setup-python@v4<\/span>\r\n        <span class=\"na\">with<\/span><span class=\"pi\">:<\/span>\r\n          <span class=\"na\">python-version<\/span><span class=\"pi\">:<\/span> <span class=\"s1\">'<\/span><span class=\"s\">3.11'<\/span>\r\n          <span class=\"na\">cache<\/span><span class=\"pi\">:<\/span> <span class=\"s1\">'<\/span><span class=\"s\">poetry'<\/span>\r\n      <span class=\"pi\">-<\/span> <span class=\"na\">name<\/span><span class=\"pi\">:<\/span> <span class=\"s\">Install Packages<\/span>\r\n        <span class=\"na\">run<\/span><span class=\"pi\">:<\/span> <span class=\"s\">poetry install<\/span>\r\n      <span class=\"pi\">-<\/span> <span class=\"na\">name<\/span><span class=\"pi\">:<\/span> <span class=\"s\">Create documentation<\/span>\r\n        <span class=\"na\">run<\/span><span class=\"pi\">:<\/span> <span class=\"s\">poetry run pdoc -o docs application\/tests\/<\/span>\r\n      <span class=\"pi\">-<\/span> <span class=\"na\">name<\/span><span class=\"pi\">:<\/span> <span class=\"s\">Upload Documents<\/span>\r\n        <span class=\"na\">uses<\/span><span class=\"pi\">:<\/span> <span class=\"s\">actions\/upload-pages-artifact@v1<\/span>\r\n        <span class=\"na\">with<\/span><span class=\"pi\">:<\/span>\r\n          <span class=\"c1\"># \u7d76\u5bfe\u30d1\u30b9\u3092\u6307\u5b9a<\/span>\r\n          <span class=\"na\">path<\/span><span class=\"pi\">:<\/span> <span class=\"s\">application\/docs\/<\/span>\r\n<\/code><\/pre>\n<h2>\u8ba9\u6211\u4eec\u6765\u6267\u884c\u5de5\u4f5c\u6d41\u7a0b\u5427\uff01<\/h2>\n<p>\u5982\u679c\u76f4\u63a5\u5c06\u66f4\u6539\u63d0\u4ea4\u5230develop\u5206\u652f\uff0c\u6216\u8005\u5c06PR\u5408\u5e76\u5230develop\u5206\u652f\uff0c\u5de5\u4f5c\u6d41\u7a0b\u5c06\u88ab\u6267\u884c\u3002<\/p>\n<p>\u5982\u679c\u80fd\u591f\u521b\u5efa\u540d\u4e3aGitHub Pages\u7684\u6784\u4ef6\u5e76\u6210\u529f\u5730\u5728\u94fe\u63a5\u4e0a\u8fdb\u884c\u8f6c\u79fb\u5e76\u67e5\u770b\uff0c\u5219\u8868\u793a\u6210\u529f\u3002<\/p>\n<div><img decoding=\"async\" class=\"post-images\" title=\"\" src=\"https:\/\/cdn.silicloud.com\/blog-img\/blog\/img\/657d8a33913a08637a6c8d02\/71-0.png\" alt=\"\u30b9\u30af\u30ea\u30fc\u30f3\u30b7\u30e7\u30c3\u30c8 2023-06-10 12.13.06.png\" \/><\/div>\n<div><img decoding=\"async\" class=\"post-images\" title=\"\" src=\"https:\/\/cdn.silicloud.com\/blog-img\/blog\/img\/657d8a33913a08637a6c8d02\/72-0.png\" alt=\"\u30b9\u30af\u30ea\u30fc\u30f3\u30b7\u30e7\u30c3\u30c8 2023-06-10 12.14.52.png\" \/><\/div>\n<h2>\u603b\u7ed3<\/h2>\n<p>\u7531\u4e8e\u627e\u4e0d\u5230\u4f7f\u7528Django\u548cpdoc\u5c06\u6587\u6863\u4e0a\u4f20\u5230GitHub Pages\u7684\u6587\u7ae0\uff0c\u800c\u4e14\u8fd8\u9047\u5230\u4e86\u4ece\u672a\u89c1\u8fc7\u7684\u9519\u8bef\u6d88\u606f\uff0c\u8d77\u521d\u4e0d\u77e5\u9053\u8be5\u600e\u4e48\u529e\uff0c\u6240\u4ee5\u6211\u5199\u4e86\u8fd9\u7bc7\u6587\u7ae0\u3002\u5982\u679c\u4f60\u7406\u89e3\u4e86\u539f\u7406\uff0c\u5c31\u80fd\u8f7b\u677e\u5730\u521b\u5efa\uff0c\u5e0c\u671b\u4f60\u80fd\u5c1d\u8bd5\u4e00\u4e0b\u3002<\/p>\n<h2>\u8bf7\u63d0\u4f9b\u66f4\u591a\u4e0a\u4e0b\u6587\u3002<\/h2>\n<p>&nbsp;<\/p>\n","protected":false},"excerpt":{"rendered":"<p>\u603b\u7ed3 \u4f7f\u7528pdoc\u53ef\u4ee5\u5c06\u7528Python\u7f16\u5199\u7684\u6e90\u4ee3\u7801\u8fdb\u884c\u6587\u6863\u5316\u3002 \u6b64\u5916\uff0c\u8fd8\u53ef\u4ee5\u4f7f\u7528GitHub Actions\u548c [&hellip;]<\/p>\n","protected":false},"author":9,"featured_media":0,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1],"tags":[],"class_list":["post-49206","post","type-post","status-publish","format-standard","hentry","category-uncategorized"],"yoast_head":"<!-- This site is optimized with the Yoast SEO Premium plugin v21.5 (Yoast SEO v21.5) - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>[Django + GitHub Actions] \u4f7f\u7528pdoc\u5c06\u6587\u6863\u4e0a\u4f20\u5230GitHub Pages\uff01 - Blog - Silicon Cloud<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/www.silicloud.com\/zh\/blog\/django-github-actions-\u4f7f\u7528pdoc\u5c06\u6587\u6863\u4e0a\u4f20\u5230github-pages\uff01\/\" \/>\n<meta property=\"og:locale\" content=\"zh_CN\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"[Django + GitHub Actions] \u4f7f\u7528pdoc\u5c06\u6587\u6863\u4e0a\u4f20\u5230GitHub Pages\uff01\" \/>\n<meta property=\"og:description\" content=\"\u603b\u7ed3 \u4f7f\u7528pdoc\u53ef\u4ee5\u5c06\u7528Python\u7f16\u5199\u7684\u6e90\u4ee3\u7801\u8fdb\u884c\u6587\u6863\u5316\u3002 \u6b64\u5916\uff0c\u8fd8\u53ef\u4ee5\u4f7f\u7528GitHub Actions\u548c [&hellip;]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.silicloud.com\/zh\/blog\/django-github-actions-\u4f7f\u7528pdoc\u5c06\u6587\u6863\u4e0a\u4f20\u5230github-pages\uff01\/\" \/>\n<meta property=\"og:site_name\" content=\"Blog - Silicon Cloud\" \/>\n<meta property=\"article:published_time\" content=\"2023-07-08T10:12:07+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2024-04-30T04:47:58+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/cdn.silicloud.com\/blog-img\/blog\/img\/657d8a33913a08637a6c8d02\/46-0.png\" \/>\n<meta name=\"author\" content=\"\u6e05, \u626c\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"\u4f5c\u8005\" \/>\n\t<meta name=\"twitter:data1\" content=\"\u6e05, \u626c\" \/>\n\t<meta name=\"twitter:label2\" content=\"\u9884\u8ba1\u9605\u8bfb\u65f6\u95f4\" \/>\n\t<meta name=\"twitter:data2\" content=\"4 \u5206\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/www.silicloud.com\/zh\/blog\/django-github-actions-%e4%bd%bf%e7%94%a8pdoc%e5%b0%86%e6%96%87%e6%a1%a3%e4%b8%8a%e4%bc%a0%e5%88%b0github-pages%ef%bc%81\/\",\"url\":\"https:\/\/www.silicloud.com\/zh\/blog\/django-github-actions-%e4%bd%bf%e7%94%a8pdoc%e5%b0%86%e6%96%87%e6%a1%a3%e4%b8%8a%e4%bc%a0%e5%88%b0github-pages%ef%bc%81\/\",\"name\":\"[Django + GitHub Actions] \u4f7f\u7528pdoc\u5c06\u6587\u6863\u4e0a\u4f20\u5230GitHub Pages\uff01 - Blog - Silicon Cloud\",\"isPartOf\":{\"@id\":\"https:\/\/www.silicloud.com\/zh\/blog\/#website\"},\"datePublished\":\"2023-07-08T10:12:07+00:00\",\"dateModified\":\"2024-04-30T04:47:58+00:00\",\"author\":{\"@id\":\"https:\/\/www.silicloud.com\/zh\/blog\/#\/schema\/person\/cb5556d2501da73d864cac945e8d9461\"},\"breadcrumb\":{\"@id\":\"https:\/\/www.silicloud.com\/zh\/blog\/django-github-actions-%e4%bd%bf%e7%94%a8pdoc%e5%b0%86%e6%96%87%e6%a1%a3%e4%b8%8a%e4%bc%a0%e5%88%b0github-pages%ef%bc%81\/#breadcrumb\"},\"inLanguage\":\"zh-Hans\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/www.silicloud.com\/zh\/blog\/django-github-actions-%e4%bd%bf%e7%94%a8pdoc%e5%b0%86%e6%96%87%e6%a1%a3%e4%b8%8a%e4%bc%a0%e5%88%b0github-pages%ef%bc%81\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/www.silicloud.com\/zh\/blog\/django-github-actions-%e4%bd%bf%e7%94%a8pdoc%e5%b0%86%e6%96%87%e6%a1%a3%e4%b8%8a%e4%bc%a0%e5%88%b0github-pages%ef%bc%81\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"\u9996\u9875\",\"item\":\"https:\/\/www.silicloud.com\/zh\/blog\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"[Django + GitHub Actions] \u4f7f\u7528pdoc\u5c06\u6587\u6863\u4e0a\u4f20\u5230GitHub Pages\uff01\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/www.silicloud.com\/zh\/blog\/#website\",\"url\":\"https:\/\/www.silicloud.com\/zh\/blog\/\",\"name\":\"Blog - Silicon Cloud\",\"description\":\"\",\"inLanguage\":\"zh-Hans\"},{\"@type\":\"Person\",\"@id\":\"https:\/\/www.silicloud.com\/zh\/blog\/#\/schema\/person\/cb5556d2501da73d864cac945e8d9461\",\"name\":\"\u6e05, \u626c\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"zh-Hans\",\"@id\":\"https:\/\/www.silicloud.com\/zh\/blog\/#\/schema\/person\/image\/\",\"url\":\"https:\/\/secure.gravatar.com\/avatar\/32a4239de8ff29adace466261d309424a1e5fe9f7e3036bf89fe03f2e3dbe717?s=96&d=mm&r=g\",\"contentUrl\":\"https:\/\/secure.gravatar.com\/avatar\/32a4239de8ff29adace466261d309424a1e5fe9f7e3036bf89fe03f2e3dbe717?s=96&d=mm&r=g\",\"caption\":\"\u6e05, \u626c\"},\"url\":\"https:\/\/www.silicloud.com\/zh\/blog\/author\/qingyang\/\"},{\"@type\":\"ImageObject\",\"inLanguage\":\"zh-Hans\",\"@id\":\"https:\/\/www.silicloud.com\/zh\/blog\/django-github-actions-%e4%bd%bf%e7%94%a8pdoc%e5%b0%86%e6%96%87%e6%a1%a3%e4%b8%8a%e4%bc%a0%e5%88%b0github-pages%ef%bc%81\/#local-main-organization-logo\",\"url\":\"\",\"contentUrl\":\"\",\"caption\":\"Blog - Silicon Cloud\"}]}<\/script>\n<!-- \/ Yoast SEO Premium plugin. -->","yoast_head_json":{"title":"[Django + GitHub Actions] \u4f7f\u7528pdoc\u5c06\u6587\u6863\u4e0a\u4f20\u5230GitHub Pages\uff01 - Blog - Silicon Cloud","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/www.silicloud.com\/zh\/blog\/django-github-actions-\u4f7f\u7528pdoc\u5c06\u6587\u6863\u4e0a\u4f20\u5230github-pages\uff01\/","og_locale":"zh_CN","og_type":"article","og_title":"[Django + GitHub Actions] \u4f7f\u7528pdoc\u5c06\u6587\u6863\u4e0a\u4f20\u5230GitHub Pages\uff01","og_description":"\u603b\u7ed3 \u4f7f\u7528pdoc\u53ef\u4ee5\u5c06\u7528Python\u7f16\u5199\u7684\u6e90\u4ee3\u7801\u8fdb\u884c\u6587\u6863\u5316\u3002 \u6b64\u5916\uff0c\u8fd8\u53ef\u4ee5\u4f7f\u7528GitHub Actions\u548c [&hellip;]","og_url":"https:\/\/www.silicloud.com\/zh\/blog\/django-github-actions-\u4f7f\u7528pdoc\u5c06\u6587\u6863\u4e0a\u4f20\u5230github-pages\uff01\/","og_site_name":"Blog - Silicon Cloud","article_published_time":"2023-07-08T10:12:07+00:00","article_modified_time":"2024-04-30T04:47:58+00:00","og_image":[{"url":"https:\/\/cdn.silicloud.com\/blog-img\/blog\/img\/657d8a33913a08637a6c8d02\/46-0.png"}],"author":"\u6e05, \u626c","twitter_card":"summary_large_image","twitter_misc":{"\u4f5c\u8005":"\u6e05, \u626c","\u9884\u8ba1\u9605\u8bfb\u65f6\u95f4":"4 \u5206"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/www.silicloud.com\/zh\/blog\/django-github-actions-%e4%bd%bf%e7%94%a8pdoc%e5%b0%86%e6%96%87%e6%a1%a3%e4%b8%8a%e4%bc%a0%e5%88%b0github-pages%ef%bc%81\/","url":"https:\/\/www.silicloud.com\/zh\/blog\/django-github-actions-%e4%bd%bf%e7%94%a8pdoc%e5%b0%86%e6%96%87%e6%a1%a3%e4%b8%8a%e4%bc%a0%e5%88%b0github-pages%ef%bc%81\/","name":"[Django + GitHub Actions] \u4f7f\u7528pdoc\u5c06\u6587\u6863\u4e0a\u4f20\u5230GitHub Pages\uff01 - Blog - Silicon Cloud","isPartOf":{"@id":"https:\/\/www.silicloud.com\/zh\/blog\/#website"},"datePublished":"2023-07-08T10:12:07+00:00","dateModified":"2024-04-30T04:47:58+00:00","author":{"@id":"https:\/\/www.silicloud.com\/zh\/blog\/#\/schema\/person\/cb5556d2501da73d864cac945e8d9461"},"breadcrumb":{"@id":"https:\/\/www.silicloud.com\/zh\/blog\/django-github-actions-%e4%bd%bf%e7%94%a8pdoc%e5%b0%86%e6%96%87%e6%a1%a3%e4%b8%8a%e4%bc%a0%e5%88%b0github-pages%ef%bc%81\/#breadcrumb"},"inLanguage":"zh-Hans","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.silicloud.com\/zh\/blog\/django-github-actions-%e4%bd%bf%e7%94%a8pdoc%e5%b0%86%e6%96%87%e6%a1%a3%e4%b8%8a%e4%bc%a0%e5%88%b0github-pages%ef%bc%81\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/www.silicloud.com\/zh\/blog\/django-github-actions-%e4%bd%bf%e7%94%a8pdoc%e5%b0%86%e6%96%87%e6%a1%a3%e4%b8%8a%e4%bc%a0%e5%88%b0github-pages%ef%bc%81\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"\u9996\u9875","item":"https:\/\/www.silicloud.com\/zh\/blog\/"},{"@type":"ListItem","position":2,"name":"[Django + GitHub Actions] \u4f7f\u7528pdoc\u5c06\u6587\u6863\u4e0a\u4f20\u5230GitHub Pages\uff01"}]},{"@type":"WebSite","@id":"https:\/\/www.silicloud.com\/zh\/blog\/#website","url":"https:\/\/www.silicloud.com\/zh\/blog\/","name":"Blog - Silicon Cloud","description":"","inLanguage":"zh-Hans"},{"@type":"Person","@id":"https:\/\/www.silicloud.com\/zh\/blog\/#\/schema\/person\/cb5556d2501da73d864cac945e8d9461","name":"\u6e05, \u626c","image":{"@type":"ImageObject","inLanguage":"zh-Hans","@id":"https:\/\/www.silicloud.com\/zh\/blog\/#\/schema\/person\/image\/","url":"https:\/\/secure.gravatar.com\/avatar\/32a4239de8ff29adace466261d309424a1e5fe9f7e3036bf89fe03f2e3dbe717?s=96&d=mm&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/32a4239de8ff29adace466261d309424a1e5fe9f7e3036bf89fe03f2e3dbe717?s=96&d=mm&r=g","caption":"\u6e05, \u626c"},"url":"https:\/\/www.silicloud.com\/zh\/blog\/author\/qingyang\/"},{"@type":"ImageObject","inLanguage":"zh-Hans","@id":"https:\/\/www.silicloud.com\/zh\/blog\/django-github-actions-%e4%bd%bf%e7%94%a8pdoc%e5%b0%86%e6%96%87%e6%a1%a3%e4%b8%8a%e4%bc%a0%e5%88%b0github-pages%ef%bc%81\/#local-main-organization-logo","url":"","contentUrl":"","caption":"Blog - Silicon Cloud"}]}},"_links":{"self":[{"href":"https:\/\/www.silicloud.com\/zh\/blog\/wp-json\/wp\/v2\/posts\/49206","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.silicloud.com\/zh\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.silicloud.com\/zh\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.silicloud.com\/zh\/blog\/wp-json\/wp\/v2\/users\/9"}],"replies":[{"embeddable":true,"href":"https:\/\/www.silicloud.com\/zh\/blog\/wp-json\/wp\/v2\/comments?post=49206"}],"version-history":[{"count":2,"href":"https:\/\/www.silicloud.com\/zh\/blog\/wp-json\/wp\/v2\/posts\/49206\/revisions"}],"predecessor-version":[{"id":92000,"href":"https:\/\/www.silicloud.com\/zh\/blog\/wp-json\/wp\/v2\/posts\/49206\/revisions\/92000"}],"wp:attachment":[{"href":"https:\/\/www.silicloud.com\/zh\/blog\/wp-json\/wp\/v2\/media?parent=49206"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.silicloud.com\/zh\/blog\/wp-json\/wp\/v2\/categories?post=49206"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.silicloud.com\/zh\/blog\/wp-json\/wp\/v2\/tags?post=49206"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}