{"id":304,"date":"2025-02-25T04:34:29","date_gmt":"2025-02-25T04:34:29","guid":{"rendered":"https:\/\/www.regfine.cn\/?p=304"},"modified":"2025-02-25T05:43:18","modified_gmt":"2025-02-25T05:43:18","slug":"sphinx-github-read-the-docs-%e7%9a%84%e6%96%87%e6%a1%a3%e8%a7%84%e8%8c%83","status":"publish","type":"post","link":"https:\/\/www.regfine.cn\/?p=304","title":{"rendered":"Sphinx + GitHub + Read the Docs \u7684\u6587\u6863\u89c4\u8303"},"content":{"rendered":"\n<p><a href=\"https:\/\/so.csdn.net\/so\/search?q=Sphinx&amp;spm=1001.2101.3001.7020\" target=\"_blank\" rel=\"noreferrer noopener\">Sphinx<\/a> + GitHub + Read the Docs \u7684\u6587\u6863\u7ba1\u7406\u65b9\u6cd5<\/p>\n\n\n\n<p><a href=\"https:\/\/blog.csdn.net\/lu_embedded\/article\/details\/109006380\">https:\/\/blog.csdn.net\/lu_embedded\/article\/details\/109006380<\/a><\/p>\n\n\n\n<h2 class=\"wp-block-heading\">ubuntu24.04\u5b89\u88c5\u6b65\u9aa4<\/h2>\n\n\n\n<p>sudo apt install python3-sphinx<\/p>\n\n\n\n<h2 class=\"wp-block-heading\">\u65b0\u5efa<\/h2>\n\n\n\n<ul class=\"wp-block-list\">\n<li>sphinx-quickstart\n<ul class=\"wp-block-list\">\n<li>Project name: Sphinx\u4f8b\u7a0b<\/li>\n\n\n\n<li>Author name(s): mkj<\/li>\n\n\n\n<li>Author name(s): mkj<\/li>\n<\/ul>\n<\/li>\n\n\n\n<li>make<\/li>\n\n\n\n<li><code>make html<\/code><\/li>\n\n\n\n<li>\u9884\u89c8\n<ul class=\"wp-block-list\">\n<li>build\/html\/index.html\u5c31\u662f\u751f\u6210\u7684\u6587\u6863<\/li>\n\n\n\n<li>sphinx-autobuild source build\/html\n<ul class=\"wp-block-list\">\n<li>sudo apt install python3-sphinx-autobuild<\/li>\n\n\n\n<li>\u9ed8\u8ba4\u542f\u52a8 8000 \u7aef\u53e3\uff0c\u5728\u6d4f\u89c8\u5668\u8f93\u5165 <a href=\"http:\/\/127.0.0.1:8000\">http:\/\/127.0.0.1:8000<\/a><\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n\n\n\n<p>vs\u63d2\u4ef6<\/p>\n\n\n\n<p><a href=\"https:\/\/ebf-contribute-guide.readthedocs.io\/zh-cn\/latest\/install-sphinx-env\/vscode.html\">https:\/\/ebf-contribute-guide.readthedocs.io\/zh-cn\/latest\/install-sphinx-env\/vscode.html<\/a><\/p>\n\n\n\n<p><a href=\"https:\/\/marketplace.visualstudio.com\/items?itemName=lextudio.restructuredtext\">https:\/\/marketplace.visualstudio.com\/items?itemName=lextudio.restructuredtext<\/a><\/p>\n\n\n\n<p>python\u3001reStructuredText\u3001RST Preview<\/p>\n\n\n\n<p><\/p>\n","protected":false},"excerpt":{"rendered":"<p>Sphinx + GitHub + Read the Docs \u7684\u6587\u6863\u7ba1\u7406\u65b9\u6cd5 https:\/\/blog.cs [&hellip;]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_uag_custom_page_level_css":"","site-sidebar-layout":"default","site-content-layout":"","ast-site-content-layout":"","site-content-style":"default","site-sidebar-style":"default","ast-global-header-display":"","ast-banner-title-visibility":"","ast-main-header-display":"","ast-hfb-above-header-display":"","ast-hfb-below-header-display":"","ast-hfb-mobile-header-display":"","site-post-title":"","ast-breadcrumbs-content":"","ast-featured-img":"","footer-sml-layout":"","theme-transparent-header-meta":"","adv-header-id-meta":"","stick-header-meta":"","header-above-stick-meta":"","header-main-stick-meta":"","header-below-stick-meta":"","astra-migrate-meta-layouts":"default","ast-page-background-enabled":"default","ast-page-background-meta":{"desktop":{"background-color":"var(--ast-global-color-4)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"tablet":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"mobile":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""}},"ast-content-background-meta":{"desktop":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"tablet":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"mobile":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""}},"footnotes":""},"categories":[19],"tags":[],"class_list":["post-304","post","type-post","status-publish","format-standard","hentry","category-19"],"uagb_featured_image_src":{"full":false,"thumbnail":false,"medium":false,"medium_large":false,"large":false,"1536x1536":false,"2048x2048":false},"uagb_author_info":{"display_name":"admin","author_link":"https:\/\/www.regfine.cn\/?author=1"},"uagb_comment_info":2,"uagb_excerpt":"Sphinx + GitHub + Read the Docs \u7684\u6587\u6863\u7ba1\u7406\u65b9\u6cd5 https:\/\/blog.cs&hellip;","_links":{"self":[{"href":"https:\/\/www.regfine.cn\/index.php?rest_route=\/wp\/v2\/posts\/304","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.regfine.cn\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.regfine.cn\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.regfine.cn\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.regfine.cn\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=304"}],"version-history":[{"count":14,"href":"https:\/\/www.regfine.cn\/index.php?rest_route=\/wp\/v2\/posts\/304\/revisions"}],"predecessor-version":[{"id":325,"href":"https:\/\/www.regfine.cn\/index.php?rest_route=\/wp\/v2\/posts\/304\/revisions\/325"}],"wp:attachment":[{"href":"https:\/\/www.regfine.cn\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=304"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.regfine.cn\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=304"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.regfine.cn\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=304"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}