diff --git a/.github/workflows/development.yml b/.github/workflows/development.yml index 18a6a3e3..28b64c0f 100644 --- a/.github/workflows/development.yml +++ b/.github/workflows/development.yml @@ -1,36 +1,15 @@ -# This is a basic workflow to help you get started with Actions - -name: CI - -# Controls when the workflow will run +name: Development on: - # Triggers the workflow on push or pull request events but only for the "main" branch push: - branches: [ "main" ] - pull_request: - branches: [ "main" ] - - # Allows you to run this workflow manually from the Actions tab - workflow_dispatch: - -# A workflow run is made up of one or more jobs that can run sequentially or in parallel + branches: + - main jobs: - # This workflow contains a single job called "build" - build: - # The type of runner that the job will run on + deploy: runs-on: ubuntu-latest - - # Steps represent a sequence of tasks that will be executed as part of the job steps: - # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it - - uses: actions/checkout@v3 - - # Runs a single command using the runners shell - - name: Run a one-line script - run: echo Hello, world! - - # Runs a set of commands using the runners shell - - name: Run a multi-line script - run: | - echo Add other actions to build, - echo test, and deploy your project. + - uses: actions/checkout@v2 + - uses: actions/setup-python@v2 + with: + python-version: 3.x + - run: pip install mkdocs-material + - run: mkdocs gh-deploy --force diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 00000000..8f8550e1 --- /dev/null +++ b/.gitmodules @@ -0,0 +1,8 @@ +[submodule "docs/sub_docs/element-array-ephys"] + path = docs/sub_docs/element-array-ephys + url = https://github.com/A-Baji/element-array-ephys.git + branch = gh-pages +[submodule "docs/element-array-ephys"] + path = docs/element-array-ephys + url = https://github.com/A-Baji/element-array-ephys.git + branch = gh-pages diff --git a/docker-compose-mkdocs-serve.yaml b/docker-compose-mkdocs-serve.yaml new file mode 100644 index 00000000..730fae66 --- /dev/null +++ b/docker-compose-mkdocs-serve.yaml @@ -0,0 +1,21 @@ +# docker-compose -f ./docker-compose-mkdocs-serve.yaml up --build +version: "2.4" +services: + docs: + build: + context: . + dockerfile: docs.dockerfile + environment: + - THEME_DIR=material + volumes: + - .:/main + ports: + - 80:80 + command: + - bash + - -c + - | + pwd + mkdocs --version + mkdocs serve -a 0.0.0.0:80 + # tail -f /dev/null diff --git a/docker-compose-multirepo-build.yaml b/docker-compose-multirepo-build.yaml new file mode 100644 index 00000000..59da6d45 --- /dev/null +++ b/docker-compose-multirepo-build.yaml @@ -0,0 +1,20 @@ +# HOST_UID="$(id -u)" HOST_GID="$(id -g)" docker-compose -f ./docker-compose-multirepo-build.yaml up --build +version: "2.4" +services: + docs: + build: + context: . + dockerfile: docs.build.dockerfile + volumes: + - .:/main + user: '${HOST_UID}:${HOST_GID}' + command: + - bash + - -c + - | + pwd + git init + git submodule init + git submodule update + git submodule foreach git pull origin gh-pages + # tail -f /dev/null diff --git a/docs.build.dockerfile b/docs.build.dockerfile new file mode 100644 index 00000000..0ff27cfb --- /dev/null +++ b/docs.build.dockerfile @@ -0,0 +1,5 @@ +FROM python:latest + +WORKDIR /main +COPY . /main +RUN pip install mkdocs mkdocs-material \ No newline at end of file diff --git a/docs.dockerfile b/docs.dockerfile new file mode 100644 index 00000000..63fea08e --- /dev/null +++ b/docs.dockerfile @@ -0,0 +1,5 @@ +FROM python:slim + +WORKDIR /main +COPY . /main +RUN pip install mkdocs mkdocs-material \ No newline at end of file diff --git a/docs/assets/elements-logo.png b/docs/assets/elements-logo.png new file mode 100644 index 00000000..19b392a9 Binary files /dev/null and b/docs/assets/elements-logo.png differ diff --git a/docs/element-array-ephys b/docs/element-array-ephys new file mode 160000 index 00000000..97b46206 --- /dev/null +++ b/docs/element-array-ephys @@ -0,0 +1 @@ +Subproject commit 97b4620698de3c012afdb39b39ee6c85ffeeacc4 diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 00000000..d33d2ef7 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,56 @@ +# Welcome to Docs Hub + +For full documentation visit [mkdocs.org](https://www.mkdocs.org). + +## Projects + + + +
+ + + + +## Commands + +* `mkdocs new [dir-name]` - Create a new project. +* `mkdocs serve` - Start the live-reloading docs server. +* `mkdocs build` - Build the documentation site. +* `mkdocs -h` - Print help message and exit. + +## Project layout + + mkdocs.yml # The configuration file. + docs/ + index.md # The documentation homepage. + ... # Other markdown pages, images and other files. diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css new file mode 100644 index 00000000..9a8e3ecf --- /dev/null +++ b/docs/stylesheets/extra.css @@ -0,0 +1,36 @@ +[data-md-color-scheme="datajoint"] { + + --dj-yellow: #fcb954; + + --md-primary-fg-color: var(--dj-yellow); + --md-primary-bg-color: #000000; + --md-primary-fg-color--dark: var(--dj-yellow); + + --md-accent-fg-color: var(--dj-yellow); + + --md-code-bg-color: #e4f3f6; + + --md-footer-fg-color: var(--dj-yellow); +} + +[data-md-color-scheme="slate"] { + + --dj-yellow: #fcb954; + + --md-typeset-color: #e4f3f6; + --md-typeset-a-color: #17b2ff; + + --md-default-fg-color: #e4f3f6; + --md-default-fg-color--light: var(--dj-yellow); + + --md-primary-fg-color: var(--dj-yellow); + --md-primary-bg-color: #000000; + --md-primary-fg-color--dark: var(--dj-yellow); + + --md-accent-fg-color: var(--dj-yellow); + + --md-code-fg-color: #76c9e9; + --md-code-hl-comment-color: #ffd28d; + + --md-footer-fg-color: var(--dj-yellow); +} \ No newline at end of file diff --git a/docs/stylesheets/styles.css b/docs/stylesheets/styles.css new file mode 100644 index 00000000..04f0c1a8 --- /dev/null +++ b/docs/stylesheets/styles.css @@ -0,0 +1,44 @@ +section { + max-width: 44.5rem; + padding: 0; + color: #3c4043; + line-height: 1.25rem; +} + +section ul { + margin: 0; + outline: 0; + padding: 0; + display: inline-block; + max-width: 44.5rem; +} + +section li { + min-height: 3.125rem; + vertical-align: top; + display: inline-block; +} + +section li > a { + max-height: 7rem; + padding: 0.5rem; + margin: 0.5rem; + border: .0625rem solid #dadce0; + border-radius: .5rem; + display: block; +} + +section li img { + width: 4rem; + height: auto; + display: block; + margin-left: auto; + margin-right: auto; +} + +section li span { + height: auto; + display: block; + margin: .5rem 0; + text-align: center; +} \ No newline at end of file diff --git a/docs/sub_docs.html b/docs/sub_docs.html new file mode 100644 index 00000000..df18da4b --- /dev/null +++ b/docs/sub_docs.html @@ -0,0 +1,16 @@ + + + + + +
+ Element Array Ephys
+
+