V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
V2EX 提问指南
jenlors
V2EX  ›  问与答

各位,你们都是怎么为自己的开源项目编写文档的?

  •  
  •   jenlors · 2020-09-21 15:29:58 +08:00 · 883 次点击
    这是一个创建于 1535 天前的主题,其中的信息可能已经有所发展或是发生改变。

    总感觉编写项目文档是比写项目本身还要困难的事,是的,我就是那个不爱写文档的😂

    之前使用 sphinx 加 rst 的方式,感觉用起来不是很顺手,而且本身更喜欢 markdown,现在准备用 mkdocs 重新写一遍文档。

    顺便为我的项目求个 star,https://github.com/long2ice/fastapi-admin,感谢各位~

    2 条回复    2020-09-21 16:00:35 +08:00
    so1n
        1
    so1n  
       2020-09-21 15:38:39 +08:00
    你项目现在都用 tortoise-orm 吗
    jenlors
        2
    jenlors  
    OP
       2020-09-21 16:00:35 +08:00
    是的
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   5746 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 23ms · UTC 02:45 · PVG 10:45 · LAX 18:45 · JFK 21:45
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.