Giter Club home page Giter Club logo

rtddocs's Introduction

如何使用Sphinx搭建rtd文档

yum -y install python-sphinx

mkdir /home/ssslinpp/rtdocs -p
cd /home/ssslinppp/rtdocs

# 快速搭建(选择build与source分别创建)
sphinx-quickstart 

文件目录结构:

build  #运行make命令后,生成的文件都在这个目录里面 
source #放置文档的源文件 
make.bat #批处理命令 
makefile

生成html目录结构

make html

在github上创建仓库,然后执行如下命令:

git init   #注释,初始化仓库
git add . # 添加所有的修改
git commit -m "sphinx start"  # 提交到本地
git remote add origin http://github.com/[yourusername]/[yourrepository].git #设置远端 这里面,需要你在github上面提前建好一个repository,然后才能顺利推送成功。
git push origin master  #推送到远端git

导入到ReadtheDocs

还是在github里面进入到你创建的远端仓库里面,进入settings -> Service 然后添加 readtheDocs,然后你需要进入ReadtheDocs里面创建一个账号(如果没有账号的话),连接你的github账号,把你的仓库导入,导入成功之后,点击阅读文档。就可以看到web效果了

rtddocs's People

Contributors

ssslinppp avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.