Initial commit

.github/workflows/static.yml

@@ -0,0 +1,54 @@
+# Simple workflow for deploying static content to GitHub Pages
+name: Deploy static content to Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches:
+      - "main"
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Single deploy job since we're just deploying
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - run: pipx install poetry
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+          cache: "poetry"
+      - run: |
+          poetry install
+          poetry run task docs-build
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v2
+        with:
+          # Upload entire repository
+          path: './build/html'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2

.gitignore

@@ -0,0 +1,2 @@
+venv
+build

README.md

@@ -0,0 +1,53 @@
+# dataverse.org (Sphinx)
+
+This GitHub project hosts the sources from which the Dataverse website at https://sphinx.dataverse.org is built.
+If we like Sphinx, we might switch https://dataverse.org to it.
+Builds are automated and any commited changes will be released by automation.
+
+You can do smaller edits using the GitHub integrated web editor for files and change the Markdown based content.
+For larger changes, we recommend working with a local setup, also allowing to preview your changes.
+See below for a tutorial how to start your local setup.
+
+## Prepare your environment
+
+First, install Python 3.9 (or later).
+
+Additionally, you need to [install `poetry >= 1.2.0`](https://python-poetry.org/docs/#installation), either globally, or within an environment of your choice.
+As a project, we chose `poetry` to manage our dependencies, builds, and deposits as a state of the art solution within the Python ecosystem.
+
+## Get the source code
+
+Next, you need to obtain a version of the website "source code".
+
+You can either download it as a zipped package or clone the whole Git repository.
+You can clone the repository and enter the project directory as follows:
+
+```shell
+git clone https://github.com/IQSS/sphinx.dataverse.org.git
+cd sphinx.dataverse.org
+```
+
+## Build the website for preview
+
+To build the website in your *poetry* environment, run the
+following commands from the project root:
+
+```shell
+poetry install
+poetry run task docs-build
+```
+
+On Linux you can use `xdg-open`, on Mac `open` to see the built output in your browser:
+```shell
+xdg-open build/html/index.html
+```
+
+Or use [`sphinx-autobuild`](https://github.com/executablebooks/sphinx-autobuild) to enable a self-updating preview service:
+
+```shell
+poetry install
+poetry run task docs-live
+```
+
+The page will automatically be opened for you in a browser window or tab.
+**Note:** enabling auto-reload without user interaction requires you to install the "LiveReload" extension for your browser.

pyproject.toml

@@ -0,0 +1,38 @@
+[tool.poetry]
+name = "gdcc-website"
+version = "0.1.0"
+description = "Sphinx project for GDCC's main website"
+homepage = "https://dataverscommunity.global"
+authors = [
+    "Oliver Bertuch <[email protected]>",
+]
+
+readme = "README.md"
+repository = "https://github.com/gdcc/www.gdcc.io"
+
+[tool.poetry.dependencies]
+python = "^3.9"
+taskipy = "^1.10.3"
+
+Sphinx = "^7.2.6"
+# Sphinx - Additional modules
+myst-parser = "^2.0.0"
+pydata-sphinx-theme = "^0.14.1"
+sphinx-favicon = "^0.2"
+sphinxcontrib-contentui = "^0.2.5"
+sphinxcontrib-images = "^0.9.4"
+sphinx-icon = "^0.1.2"
+sphinx-autobuild = "^2021.3.14"
+sphinxemoji = "^0.2.0"
+sphinxext-opengraph = "^0.6.3"
+sphinxcontrib-mermaid="^0.8.1"
+sphinx-togglebutton="^0.3.2"
+
+[tool.taskipy.tasks]
+docs-build = "poetry run sphinx-build -M html source build -W --keep-going"
+docs-clean = "poetry run sphinx-build -M clean source build"
+docs-live = "poetry run sphinx-autobuild source build/html --open-browser --delay=2"
+
+[build-system]
+requires = ["poetry-core>=1.2.0"]
+build-backend = "poetry.core.masonry.api"

source/about/index.md

@@ -0,0 +1,2 @@
+# About
+

source/best-practices/academic-credit/index.md

@@ -0,0 +1,2 @@
+# Academic Credit
+

source/best-practices/index.md

@@ -0,0 +1,7 @@
+# Best Practices
+
+
+```{toctree}
+academic-credit/index.md
+```
+

source/community/index.md

@@ -0,0 +1,2 @@
+# Community
+

source/conf.py

@@ -0,0 +1,45 @@
+from datetime import datetime
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'The Dataverse Project'
+copyright = u'%d, The President & Fellows of Harvard College' % datetime.now().year
+author = 'The Dataverse Project'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = ["myst_parser"]
+
+templates_path = ['_templates']
+exclude_patterns = []
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'pydata_sphinx_theme'
+html_logo = '_static/_images/dataverse_r_project.png'
+html_static_path = ['_static']
+# "The header navigation bar is at the top of each page and contains top-level navigation across pages in your documentation, as well as extra links and components that you can add." -- https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/header-links.html
+html_theme_options = {
+  "show_prev_next": False,
+  "header_links_before_dropdown": 5,
+  # see https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/source-buttons.html
+  "use_edit_page_button": True,
+  "external_links": [
+      {"name": "Working Groups", "url": "https://www.gdcc.io/working-groups.html"}
+  ]
+}
+html_context = {
+    "github_user": "IQSS",
+    "github_repo": "sphinx.dataverse.org",
+    "github_version": "main",
+    "doc_path": "source",
+}
+# see use_edit_page_button, which we use instead
+html_show_sourcelink = False

source/contact/index.md

@@ -0,0 +1 @@
+# Contact

source/developers/index.md

@@ -0,0 +1 @@
+# Developers

source/index.md

@@ -0,0 +1,21 @@
+# The Dataverse Project
+
+Open source research data repository software 
+
+- [Researchers](researchers/index)
+- [Journals](journals/index)
+- [Institutions](institutions/index)
+- [Developers](developers/index)
+
+```{toctree}
+:hidden:
+about/index
+community/index
+best-practices/index
+software/index
+contact/index
+researchers/index
+journals/index
+institutions/index
+developers/index
+```

source/institutions/index.md

@@ -0,0 +1 @@
+# Institutions

source/journals/index.md

@@ -0,0 +1 @@
+# Journals

source/researchers/index.md

@@ -0,0 +1 @@
+# Researchers

source/software/index.md

@@ -0,0 +1,2 @@
+# Software
+