Skip to content

rainyNighti/CSE-BAOYAN

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

保研攻略

Read the Docs

地址:https://postgraduate-recommendation.readthedocs.io/zh_CN/latest/

由中南软工学长学姐编写的保研攻略,希望大家都能更快更高效更少踩坑地成功保研,拥有光明的未来。 目前正在收集2020级保研经验贴,欢迎大家 Star & Fork 帮助学弟学妹们!

TODO

  1. 通用建议和文书准备

贡献

构建

  1. Fork本项目
  2. Clone到本地
  3. 安装环境
conda create --name baoyan
conda activate baoyan
pip install sphinx restructuredtext-lint sphinx_rtd_theme
  1. 修改项目
  2. 生成html文件:工程目录下执行:make clean && make html
  3. 使用浏览器打开build/html/index.html,即可预览已经产生的文档!

本项目使用reStructuredText进行写作,新版的Python文档就是由Sphinx生成的,并且它已成为Python项目首选的文档工具,语法和MarkDown差不多,用到什么语法点击这里查就可以。

本项目使用sphinx进行文档生成,如果需要学习对项目进行修改,请查看sphinx的文档,或者这个教程

Tips

  • 插入本地图片可用如下语法:
    • .. image:: ../../../static/test.png
  • 设定锚点内连接语法:
    • .. _anchor:
    • 使用锚点<anchor>

贡献

您可以用如下两种方式对此项目进行贡献:

  • fork项目之后发PR
  • 联系雨夜闭门 (GitHub)获取本项目写权限后,往本项目中非master分支提交您的内容,再发PR

在文档中手工维护,若您是第一次贡献本项目,并希望将自己的个人信息写在文档中,请进行以下步骤(若您不想加入,则可以什么都不做):

  • sources/authors.rst中,根据已有的格式加入您的个人信息

许可证

本项目所有文本内容在CC BY-NC-SA 4.0下授权。

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published