Merge pull request #1 from huggingface/doc-builder

Doc builder testing PR

.github/workflows/build_documentation.yml

@@ -0,0 +1,20 @@
+name: Build documentation
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    uses: huggingface/doc-builder/.github/workflows/build_main_documentation.yml@main
+    with:
+      commit_sha: ${{ github.sha }}
+      package: rlhf-handbook
+#      package_name: rlhf-handbook # commented from audio-course
+      path_to_docs: rlhf-handbook/chapters/
+      additional_args: --not_python_module
+      languages: en
+    secrets:
+      token: ${{ secrets.HUGGINGFACE_PUSH }}
+      hf_token: ${{ secrets.HF_DOC_BUILD_PUSH }}

.github/workflows/build_pr_documentation.yml

@@ -0,0 +1,19 @@
+name: Build PR Documentation
+
+on:
+  pull_request:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    uses: huggingface/doc-builder/.github/workflows/build_pr_documentation.yml@main
+    with:
+      commit_sha: ${{ github.event.pull_request.head.sha }}
+      pr_number: ${{ github.event.number }}
+      package: rlhf-handbook
+      path_to_docs: rlhf-handbook/chapters/
+      additional_args: --not_python_module
+      languages: en

.github/workflows/delete_doc_comment_trigger.yml

@@ -0,0 +1,12 @@
+name: Delete doc comment trigger
+
+on:
+  pull_request:
+    types: [ closed ]
+
+
+jobs:
+  delete:
+    uses: huggingface/doc-builder/.github/workflows/delete_doc_comment_trigger.yml@main
+    with:
+      pr_number: ${{ github.event.number }}

.github/workflows/upload_pr_documentation.yml

@@ -0,0 +1,16 @@
+name: Upload PR Documentation
+
+on:
+  workflow_run:
+    workflows: ["Build PR Documentation"]
+    types:
+      - completed
+
+jobs:
+  build:
+    uses: huggingface/doc-builder/.github/workflows/upload_pr_documentation.yml@main
+    with:
+      package_name: rlhf-handbook
+    secrets:
+      hf_token: ${{ secrets.HF_DOC_BUILD_PUSH }}
+      comment_bot_token: ${{ secrets.COMMENT_BOT_TOKEN }}

.gitignore

@@ -157,4 +157,4 @@ cython_debug/
 #  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
-#.idea/
+.idea/

README.md

@@ -1,3 +1,20 @@
 # The RLHF Handbook
 
 Robust recipes for RLHF
+
+## Developing
+To view this locally, run the following (need to point to a specific language if previewing only one section, preview/`build_doc` does not use the `--language` flag):
+```shell
+doc-builder preview rlhf-handbook {docs_dir} --not_python_module
+```
+Example `docs_dir` is `~/Documents/HuggingFace/dev/rlhf-handbook/chapters/en`
+
+## Installation
+Create a new conda environment with:
+```shell
+conda create -n rlhf-handbook python=3.10
+```
+Install the limited requirements with
+```shell
+pip install -r requirements.txt
+```

chapters/en/_toctree.yml

@@ -0,0 +1,4 @@
+- title: Unit 0. Welcome to the course!
+  sections:
+  - local: chapter0/introduction
+    title: What to expect from the course

chapters/en/chapter0/introduction.mdx

@@ -1 +1,2 @@
-# Welcome to the RLHF Handbook!
+# Welcome to the RLHF Handbook!
+We are going to...

requirements.txt

@@ -0,0 +1,3 @@
+hf-doc-builder>=0.4.0
+black>=23.3.0
+watchdog>=3.0.0