Setting up the initial documentation website

Author: rclune

.gitignore

@@ -0,0 +1,2 @@
+# github pages
+docs/build

CONTRIBUTING.md

@@ -1,2 +1,10 @@
 # huggingface_datasets
-A repository to house and host the documentation and infrastructure for the datasets hosted on HuggingFace. 
+This is a repository that houses the files and infrastructure for the website that documents the Rosetta Commons datasets that are hosted on HuggingFace. 
+
+You can find the Rosetta Commons organization on HuggingFace [here](https://huggingface.co/RosettaCommons).
+
+The documentation will be hosted at [rosettacommons.github.io/huggingface_datasets](https://rosettacommons.github.io/RFdiffusion2/).
+
+For more information about how to contribute to this documentation, see the [README in the docs folder](docs/README.md). 
+
+For any questions, comments, or concerns please reach out to Rachel Clune (@rclune), Hope Woods, or Matt O'Meara on Slack. 

LICENSE.md

@@ -0,0 +1,29 @@
+name: documentation
+
+on: [push, pull_request, workflow_dispatch]
+
+permissions:
+  contents: write
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+      - name: Install dependencies
+        run: |
+          pip install sphinx myst_parser furo sphinx-copybutton
+      - name: Sphinx build
+        run: |
+          sphinx-build -M html docs/source/ docs/build/
+      - name: Disable Jekyll
+        run: touch docs/build/html/.nojekyll
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/production' }}
+        with:
+          publish_branch: gh-pages
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: docs/build/html
+          force_orphan: true

README.md

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/.github/workflows/documentation.yaml

@@ -0,0 +1,25 @@
+# Documentation for HuggingFace Datasets
+
+The documentation pages are static HTML pages generated by Sphinx and hosted on GitHub pages. The workflow that automatically creates the GitHub pages site when any pull request is accepted can be found in `.github/workflows/documentation.yaml`. The Markdown, ReStructuredText, etc. files that are used to generate the static HTML pages are in `docs/source` and the built pages are in `docs/build`.
+
+To build the documentation you will need to have a few dependencies installed, which can easily be done by running
+```bash
+pip install -r docs_requirements.txt
+```
+from within the `docs` folder. 
+
+Once this is installed you can build the documentation by running 
+```bash
+make html
+```
+from inside the `docs` folder.
+
+The static HTML pages can be found in `build/html`.
+
+
+## Adding to the documentation
+If you need more information than what is described here, please see the [Sphinx documentation](https://www.sphinx-doc.org/en/master/index.html).
+
+Anything you want to add to the documentation needs to go into the `docs/source` folder. If you add a new page, it will not be built until you add it to an `index.rst` file. You will find one in the `source` directory, and one in the `category1` subfolder for an example of how this documentation could be organized. See the `category1/index.rst` file for how you can either show a Markdown file that is hosted in this repository or directly link out to a file that is hosted on HuggingFace. 
+
+Once you make changes you will need to rebuild the documentation to have the changes reflected in the built documents. 

docs/Makefile

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/README.md

@@ -0,0 +1,2 @@
+# Dataset 1
+This file could link out to the [README](README.md) on HuggingFace, but then provide more details.