[airavata-user-docs] branch main updated: Update to work with latest mkdocs

[ma...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

machristie pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/airavata-user-docs.git


The following commit(s) were added to refs/heads/main by this push:
     new eee3be1  Update to work with latest mkdocs
eee3be1 is described below

commit eee3be1a17ebd05ff2c12aae533437e8632faf8a
Author: Marcus Christie <ma...@apache.org>
AuthorDate: Fri Apr 1 11:53:59 2022 -0400

    Update to work with latest mkdocs
---
 .gitignore       |  3 ++-
 README.md        | 26 ++++++++++++++++++++++----
 mkdocs.yml       |  2 +-
 requirements.txt | 17 +++++++++++++++++
 4 files changed, 42 insertions(+), 6 deletions(-)

diff --git a/.gitignore b/.gitignore
index 44c9b29..a55b02d 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,2 +1,3 @@
 # Apache Airavata documentation
-site/
\ No newline at end of file
+site/
+venv/
diff --git a/README.md b/README.md
index 0334e12..6a894ef 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,27 @@
-# Apache Airavata
+# Apache Airavata User Documentation
 
-Apache Airavata project documentation with Markdown.
+Apache Airavata user documentation with Markdown.
 
 ---
 
-- View the [Apache Airavata documentation][airavata-doc].
+- View the [Apache Airavata user documentation][airavata-doc].
 
-[airavata-doc]: http://airavata.readthedocs.io
+[airavata-doc]: http://airavata-user-docs.readthedocs.io
+
+
+## Building documentation
+
+## Documentation
+
+Create a virtual environment first (one time setup):
+
+```
+python3 -m venv venv
+source venv/bin/activate
+pip install -r requirements.txt
+```
+
+Build the documentation locally:
+```
+mkdocs serve
+```
diff --git a/mkdocs.yml b/mkdocs.yml
index 3362230..07d361d 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -6,7 +6,7 @@ repo_url: https://github.com/apache/airavata-docs
 
 docs_dir: docs
 
-pages:
+nav:
 - Home: 'index.md'
 - User Documentation:
   - Gateway User Tutorials: 'user-documentation/user-tutorials.md'
diff --git a/requirements.txt b/requirements.txt
new file mode 100644
index 0000000..6ef0e42
--- /dev/null
+++ b/requirements.txt
@@ -0,0 +1,17 @@
+click==8.1.2
+ghp-import==2.0.2
+importlib-metadata==4.11.3
+Jinja2==3.1.1
+Markdown==3.3.6
+MarkupSafe==2.1.1
+mergedeep==1.3.4
+mkdocs==1.3.0
+packaging==21.3
+pyparsing==3.0.7
+python-dateutil==2.8.2
+PyYAML==6.0
+pyyaml_env_tag==0.1
+six==1.16.0
+typing_extensions==4.1.1
+watchdog==2.1.7
+zipp==3.7.0