From 6fd866e1a84b802b7db90ee5f8d624f46824b6a7 Mon Sep 17 00:00:00 2001 From: Victor Hu Date: Thu, 20 Aug 2015 16:09:31 -0400 Subject: [PATCH] Update the README to reflect the new documentation URL --- README | 2 +- docs/README.md | 18 ++++++++++++++++++ 2 files changed, 19 insertions(+), 1 deletion(-) create mode 100644 docs/README.md diff --git a/README b/README index 0696fd032..035cc75d7 100644 --- a/README +++ b/README @@ -2,7 +2,7 @@ xCAT - eXtreme Cloud Administration Toolkit xCAT is a toolkit for the deployment and administration of clusters. -xCAT documentation is available at: http://xcat.sourceforge.net/ +xCAT documentation is available at: http://xcat-docs.readthedocs.org/en/latest/ xCAT is made available as open source software under the EPL license: http://www.opensource.org/licenses/eclipse-1.0.php diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 000000000..bb674eac9 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,18 @@ +# Welcome to the xCAT documentation + +We are working on improving the documentation. The latest docs are here: http://xcat-docs.readthedocs.org/en/latest/ + +The documentation project is written in restructured text (.rst) using Sphinx. +To build the docs locally: + +* Clone the project +* Using pip, install sphinx (See: http://pip.readthedocs.org/) +~~~~ + pip install sphinx +~~~~ +* Build the Docs +~~~~ + cd xcat-docs/docs + make html +~~~~ +* View the docs by opening index.html from a web browser under xcat-docs/docs/build/html/index.html