From 18cb0c1b5765794a365f6be2ab39d8ff43b60c3a Mon Sep 17 00:00:00 2001 From: Carlo Strub Date: Wed, 8 Mar 2017 08:23:38 +0000 Subject: [PATCH] update initial docs --- docs/index.md | 3 --- docs/index.rst | 41 +++++++++++++++++++++++++++++++++++++++++ mkdocs.yaml | 6 +----- 3 files changed, 42 insertions(+), 8 deletions(-) delete mode 100644 docs/index.md create mode 100644 docs/index.rst diff --git a/docs/index.md b/docs/index.md deleted file mode 100644 index d9c91fd..0000000 --- a/docs/index.md +++ /dev/null @@ -1,3 +0,0 @@ -# Sisyphus - -Hello to the documentation on Sisyphus. More to come... diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..2873df6 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,41 @@ +Sisyphus +======== + +$project will solve your problem of where to start with documentation, +by providing a basic explanation of how to do it easily. + +Look how easy it is to use: + + import project + # Get your stuff done + project.do_stuff() + +Features +-------- + +- Be awesome +- Make things faster + +Installation +------------ + +Install $project by running: + + install project + +Contribute +---------- + +- Issue Tracker: github.com/$project/$project/issues +- Source Code: github.com/$project/$project + +Support +------- + +If you are having issues, please let us know. +We have a mailing list located at: project@google-groups.com + +License +------- + +The project is licensed under the BSD license. diff --git a/mkdocs.yaml b/mkdocs.yaml index db07a28..f2ac2ea 100644 --- a/mkdocs.yaml +++ b/mkdocs.yaml @@ -1,8 +1,4 @@ site_name: Sisyphus Documentation pages: -- Home: index.md -- Getting Started: getting-started.md -- Versions and Ranges: versions.md -- Commands: commands.md -- F.A.Q.: faq.md +- Home: index.rst theme: readthedocs