码农知识堂 - 1000bd
  •   Python
  •   PHP
  •   JS/TS
  •   JAVA
  •   C/C++
  •   C#
  •   GO
  •   Kotlin
  •   Swift
  • sphinx 部分高级功能汇总说明


    什么是sphinx 就不说了,在探索sphinx 中踩了一些坑,汇总出来供参考。原本是打算写一份类似于wiki的标准文档,看到了很多企业使用了sphinx来创建,然后在学习中产生了一些疑惑,并解决了,总结如下:

    1,变量的使用,在conf.py 按照如下格式定义:

    1. rst_epilog="""
    2. .. |pnamex| replace:: wiki test project.
    3. .. |pnamex3| replace:: pnamex3 test project.
    4. .. |xxx| replace:: xxx for something.
    5. """

    然后在正文中用|pnamex| 就可以直接实现变量替换,注意上面的rst_epilog是固定内容;没有查询过是否可以有其他,但是测试其他是不行的。

    上面是全局的变量使用,如果只是文内使用,直接在文内定义,使用方法一样。

    .. |pname| replace:: wiki test project.   

    关于变量的使用,官方文档地址:

    The build configuration file — Sphinx 1.3.1 documentation

    2,条件式生产文档

  • 相关阅读:
    【TA-霜狼_may-《百人计划》】图形4.5 DoF景深基础
    一文搞定异步爬虫框架Scrapy环境的安装
    Vue Router基础知识整理
    在线云原生边缘计算KubeEdge安装配置(一)
    【Leetcode】二分查找合集
    Disqus 有评论但没显示的一种解决方案
    Ubuntu遇到Gemfiie指定版本怎么解决
    Python 全栈测试开发 Chapter8:接口测试
    Stable Diffusion 模型分享:ChilloutMix(真实、亚洲面孔)chilloutmix_NiPrunedFp32Fix
    Linux下uboot添加自定义命令(详细)实例及原理解析
  • 原文地址:https://blog.csdn.net/platform/article/details/127931553
  • 最新文章
  • 攻防演习之三天拿下官网站群
    数据安全治理学习——前期安全规划和安全管理体系建设
    企业安全 | 企业内一次钓鱼演练准备过程
    内网渗透测试 | Kerberos协议及其部分攻击手法
    0day的产生 | 不懂代码的"代码审计"
    安装scrcpy-client模块av模块异常,环境问题解决方案
    leetcode hot100【LeetCode 279. 完全平方数】java实现
    OpenWrt下安装Mosquitto
    AnatoMask论文汇总
    【AI日记】24.11.01 LangChain、openai api和github copilot
  • 热门文章
  • 十款代码表白小特效 一个比一个浪漫 赶紧收藏起来吧!!!
    奉劝各位学弟学妹们,该打造你的技术影响力了!
    五年了,我在 CSDN 的两个一百万。
    Java俄罗斯方块,老程序员花了一个周末,连接中学年代!
    面试官都震惊,你这网络基础可以啊!
    你真的会用百度吗?我不信 — 那些不为人知的搜索引擎语法
    心情不好的时候,用 Python 画棵樱花树送给自己吧
    通宵一晚做出来的一款类似CS的第一人称射击游戏Demo!原来做游戏也不是很难,连憨憨学妹都学会了!
    13 万字 C 语言从入门到精通保姆级教程2021 年版
    10行代码集2000张美女图,Python爬虫120例,再上征途
Copyright © 2022 侵权请联系2656653265@qq.com    京ICP备2022015340号-1
正则表达式工具 cron表达式工具 密码生成工具

京公网安备 11010502049817号