Sphinx是一个工具，可以轻松创建智能和漂亮的文档，他与Python自带的pydoc是同一类产品，但比pydoc更加优秀，还有很多主题可以选择，平时在开发过程中，我们看到的第三方包的文档，基本上都是用该模块自动生成的，今天我就带大家手把手将其集成到django项目当中，使其为我们的django项目自动生成文档！创建一个django的Demo项目创建虚拟环境python3mvenvvenv激活虚拟环境venvScriptsactivatewindowns激活sourcevenvbinactivatelinux激活安装djangopip3installdjango创建django项目djangoadminstartprojectmysite。创建一个demo的apppython3manage。pystartappdemo 经过以上命令我们已经成功创建了一个基础的django项目框架，之后我们就需要通过pip命令来安装Sphinx，来正式进入我们今天的主题！pip命令安装Sphinx安装sphinxpip3installsphinx查看版本号验证是否安装成功sphinxbuildversion返回版本号信息，说明安装成功sphinxbuild4。4。0创建文档布局sphinxquickstartdocs 运行这个命令后，终端会弹出创建基本目录和配置布局的一系列问题，内容如下：Separatesourceandbuilddirectories（yn）〔n〕：y是否分离源和构建目录输入yProjectname：mysite项目名称Authorname（s）：name文档作者名称Projectrelease〔〕：1。0文档版本号Projectlanguage〔en〕：文档语言，默认留空，为英文docsbuilddoctreesmake。batMakefilesourceconf。pyindex。rststatictemplatesdemoadmin。pyapps。pyinit。pymigrationsmodels。pystatictemplatestests。pyurls。pyviews。pymysiteasgi。pyinit。pysettings。pyurls。pywsgi。pydb。sqlite3manage。py 运营完以上命令之后，我们将得到如上所示的一个目录结构，docs则是我们的文档目录，docs目录中文件用途如下：build 编译生成的最终文档静态文件存放目录make。bat和Makefile 方便的脚本，用于简化一些编译操作命令，例如渲染内容。sourceconf。py 保存Sphinx项目配置的Python脚本。它包含您指定的项目名称和版本，以及一些额外的配置键。sourceindex。rst 项目的根文档，用作欢迎页面，即首页，并包含目录树。 做完以上工作之后，他还不能自动将django项目中的注释内容提取到文档当中，因为他还识别不到我们的django项目及目录，需要在sourceconf。py文件中进一步配置！。。。importosimportsys引入django，使其可以独立运行importdjango找到项目的根目录sys。path。insert（0，os。path。abspath（。。。。））os。environ〔DJANGOSETTINGSMODULE〕mysite。settings启动django命令，这个很重要django。setup（）Projectinformationprojectmysitecopyright2022，nameauthorname。。。 以上内容便是sourceconf。py中新增的配置，还需要确保在其内部的extensions配置项中配置如下代码：extensions〔sphinx。ext。todo，sphinx。ext。viewcode，sphinx。ext。autodoc〕 接下来就可以生成rst文件了，运行以下命令sphinxapidocodocssourcemysite。。mysite o后边跟随的路径是我们生成rst的保存目录，一般都存放在docssource中，至于再是否增加子目录视情况而定；空格后跟随的。。mysite则是我们需要提取的目录，这里的路径如果用相对路径不熟练的话可以用绝对路径！ 至此，我们可以看到docssource目录中多出来一个mysite的目录，并且生成了相关的rst文件，这些rst文件中的内容可以进一步手动定义，具体可以参考官方文档！编译生成html文档 这里有两种方法，假如我们目前在manage。py文件的同级目录，可以运行如下命令sphinxbuildbhtmldocssourcedocsbuildhtml 这个命令可以帮我们生成静态的html文件，并编译存放到docsbuildhtml目录中，b后边跟随的html就是编译的文档格式，当然还可以编译成好几种格式，但是一般我们django的话都编译成html，因为文档我们还要部署到线上！ 另外一种简便的方法就是进入docs目录（cddocs），直接运行makehtml即可！ 走到这一步build目录中就生成了一个html目录，这就是我们要访问的文档目录！ 但是，如何才能让这个文档在线上可以访问呢？这就需要在django项目中为文档目录配置url，让其可以访问！配置docs访问地址 在项目的配置文件settings。py中添加如下代码，路径为：mysitesettings。py集成文档DOCSURLdocsurlDOCSROOTBASEDIRdocsbuildhtml文档路径 在项目的urls。py中增加以下配置，路径为：mysiteurls。pyfromdjango。contribimportadminfromdjango。urlsimportpath新增的fromdjango。confimportsettingsfromdjango。conf。urls。staticimportstaticurlpatterns〔path（admin，admin。site。urls），加入docs目录〕static（settings。DOCSURL，documentrootsettings。DOCSROOT） 至此，启动我们的项目runserver之后，访问127。0。0。1：8000docs就可以访问到我们的文档！为文档更换主题 主题站点：https：sphinxthemes。org 这个站点为sphinx提供了很多风格的主题皮肤，我们可以去挑选适合自己的通过pip命令安装即可，安装之后只需要修改source目录中的conf。py文件中的htmlname配置项的名称为对应的主题名称即可完成换肤！ 欢迎大家关注学习，一起进步，笔者专注django相关开发，对django有深入研究，可一起学习探讨，并且承接django相关项目的开发任务！
iQOOZ3实现了没有遗憾的体验？它可能是最适合开学季入手的千元机是各大品牌占据市场份额的关键，也是众多同学开学前换机的不二选择。不过，许多手机厂商的千元机都不够有诚意，往往在不同方面有明显的缺失，降低了使用体验。而iQOOZ3就和一般……不用宽带无需插电满电待机90天翼联EDUP4G太阳能监控为您30万像素渣画质为梁上君子们打上了天然马赛克，亩产三千元电费三百元让人心痛不已，监控安装网络布线调试设置令用户直呼头大。如何选择一款靠谱的户外全景监控，高清、节能还是安装简易？……小米小屏旗舰再次受阻，安卓用户需求不高iPhone12系列今年新增了一款小尺寸mini机型，看到很多网友在议论，安卓会不会跟进，对此卢伟冰也与网友来了一波互动，结果是需要和不需要都有，但反对的声音要更高，热评前三都……合体后的海尔智家要干啥？三翼鸟青岛001号店里都讲清楚了12月23日，海尔智家完成战略重组，成为全球第一家ADH三地上市的企业。时隔三天，海尔智家又有大动作。12月26日，三翼鸟青岛体验中心001正式开业。作为首个物联网智慧家……人工智能是云服务厂商核心竞争力，BAT谁是AI云领跑者？文杨剑勇全球智能化如火如荼，继而各界对云服务保持强劲需求，将各种应用迁移、部署在云端，以此达到降本增效，提升市场竞争力。主要表现为，通过部署传感器、物联网后，有能力获取到……斑马技术EC50EC55移动终端如何助力企业打造无缝全渠道体作为致力于助力企业一线获得性能优势的解决方案提供商，斑马技术公司近日公布了其《2021全球消费者调查》结果。结果显示，疫情之下，消费者更青睐采用移动端下单和智能结帐的解决方案，……发掘非物质文化遗产还能精准扶贫？首届非遗文创节闪耀丹寨东经1074410808、北纬26052626之间，这里是黔贵小城丹寨。这里是以苗族为主的多民族聚居地，这里的自然风光让游客心驰神往，这里的苗族蜡染、古法造纸等七个项目被国务院……衣联网商品详情图怎么保存，如何下载衣联网商品的详情图衣联网作为一家主营服装批发的企业，其购物平台上有着丰富的服饰商品资源，因此衣联网上也是有着庞大的商品信息数据，而其中的商品详情图便是包含了大量商品信息，如果我们想要获取这些衣联……突发！小微企业的标准，要变了重磅！《中小企业划型标准规定（修订征求意见稿）》发布，大幅度收紧认定标准！1hr什么是小微企业？小微企业其实是一个习惯性的叫法，并没有一个严格意义上的界定，目前所说……澳洲经纪商TMGM7月交易量破纪录达1950亿美元，跻身全球TMGM在报告交易量超过1950亿美元后，现已成为全球外汇交易量排名前10的经纪商之一。2021年8月，外汇和差价合约在线交易平台TMGM刚刚发布了他们在7月的交易报告，……俄罗斯围魏救赵，一步三雕，暗助亚美尼亚亚美尼亚和阿斯拜疆已经打了半个月了，亚美尼亚因为自己先前的政治立场，一天四次向普京大帝求援，却没有得到普京总统的肯定回复，但亚美尼亚是仅仅三百万人口的小国，打不起持久战，但必定……2020年企业贷款加权平均利率4。61，未来仍有下降空间中国经济网十四五规划和2035年远景目标纲要提出，创新金融支持民营企业政策工具，健全融资增信支持体系，对民营企业信用评级、发债一视同仁，降低综合融资成本。专家表示，这些措……