Merge pull request #36 from chrisfilo/enh/mkdocs

mkdocs rendering

.circleci/config.yml

@@ -0,0 +1,26 @@
+version: 2
+jobs:
+  build:
+    docker:
+      - image: circleci/python:3.6.6
+    steps:
+      - checkout
+      - run: sudo chown -R circleci:circleci /usr/local/bin
+      - run: sudo chown -R circleci:circleci /usr/local/lib/python3.6/site-packages
+      - restore_cache:  # ensure this step occurs *before* installing dependencies
+          key: deps9-{{ .Branch }}-{{ checksum "Pipfile.lock" }}
+      - run:
+          command: |
+            sudo pip install pipenv==2018.7.1
+            pipenv install
+      - save_cache:
+          key: deps9-{{ .Branch }}-{{ checksum "Pipfile.lock" }}
+          paths:
+            - ".venv"
+            - "/usr/local/bin"
+            - "/usr/local/lib/python3.6/site-packages"
+      - run:
+          name: generate docs
+          command: pipenv run mkdocs build --clean --strict --verbose
+      - store_artifacts:
+          path: site

Pipfile

@@ -0,0 +1,13 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+mkdocs = "==1.0.4"
+mkdocs-material = "==3.0.4"
+
+[dev-packages]
+
+[requires]
+python_version = "3.6"

mkdocs.yml

@@ -3,7 +3,7 @@ theme: material
 plugins:
     - search
 docs_dir: 'src'
-use_directory_urls: false 
+use_directory_urls: false
 nav:
     - The BIDS Specification:
       - Introduction: 01-introduction.md
@@ -16,4 +16,4 @@ nav:
         - Physiological and other continous recordings: 04-modality-specific-files/04-physiological-and-other-continous-recordings.md
         - Behavioral experiments (with no MRI): 04-modality-specific-files/05-behavioural-experiments.md
       - Longitudinal and multi-site studies: 05-longitudinal-and-multi-site-studies.md
-    - The BIDS Starter Kit: https://github.com/bids-standard/bids-starter-kit
+    - The BIDS Starter Kit: https://github.com/bids-standard/bids-starter-kit