From 52168f4ed285cb2201a133fb090e50eefbc1f77c Mon Sep 17 00:00:00 2001 From: bxdd Date: Tue, 25 Apr 2023 16:10:59 +0800 Subject: [PATCH] [DOC] Update docs and readme --- CHANGES.rst | 7 +++++++ README.md | 2 +- docs/About/.gitkeep | 0 docs/About/aboutus.rst | 4 ---- .../{About/contributors.rst => about/about.rst} | 17 +++++++++++++++-- docs/about/changelog.rst | 1 + docs/index.rst | 10 ++++++++++ 7 files changed, 34 insertions(+), 7 deletions(-) create mode 100644 CHANGES.rst delete mode 100644 docs/About/.gitkeep delete mode 100644 docs/About/aboutus.rst rename docs/{About/contributors.rst => about/about.rst} (84%) create mode 100644 docs/about/changelog.rst diff --git a/CHANGES.rst b/CHANGES.rst new file mode 100644 index 0000000..4f9529f --- /dev/null +++ b/CHANGES.rst @@ -0,0 +1,7 @@ +Changelog +========= +Here you can see the full list of changes between each Learnware Market release. + +Version 0.1.0 +------------- +This is the initial release of Learnware Market. diff --git a/README.md b/README.md index 7c5132e..a3d0624 100644 --- a/README.md +++ b/README.md @@ -255,6 +255,6 @@ TODO: Here paste the github API after publishing: [Pic after publish]() -## About Us +## About us Visit [LAMDA's official website](http://www.lamda.nju.edu.cn/MainPage.ashx), diff --git a/docs/About/.gitkeep b/docs/About/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/docs/About/aboutus.rst b/docs/About/aboutus.rst deleted file mode 100644 index 3ce1439..0000000 --- a/docs/About/aboutus.rst +++ /dev/null @@ -1,4 +0,0 @@ -About us -================ - -`Visit LAMDA's official website `_ diff --git a/docs/About/contributors.rst b/docs/about/about.rst similarity index 84% rename from docs/About/contributors.rst rename to docs/about/about.rst index e07fbff..dbe4c59 100644 --- a/docs/About/contributors.rst +++ b/docs/about/about.rst @@ -1,8 +1,21 @@ -All Contributors ================ +Contributors +================ + + + +Contributors +================ + +We thank all the contributors for the development of learnware package: + +TODO: Here paste the github API after publishing: + + +In LAMDA Group, also many people participate the discussions, learnware package design and development, visual intersections and so on. Here is their name and homepage for connections: +----------------+----------------------------------------------------------------------+ -| Contributor | Homepage | +| Name | Homepage | +================+======================================================================+ | Zhi-Hao Tan | `Zhi-Hao Tan's Homepage `_ | +----------------+----------------------------------------------------------------------+ diff --git a/docs/about/changelog.rst b/docs/about/changelog.rst new file mode 100644 index 0000000..1cb32f6 --- /dev/null +++ b/docs/about/changelog.rst @@ -0,0 +1 @@ +.. include:: ../../CHANGES.rst \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index 9e743cc..0a21e34 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -64,3 +64,13 @@ Document Structure API +.. toctree:: + :maxdepth: 3 + :caption: ABOUTS: + + Contributors + Changelog + About us + + +