Merge pull request #3273 from flairNLP/doc-page

creating a doc page with autodocs and everything
flairNLP · Sep 18, 2023 · d5c1558 · d5c1558
2 parents 8b997ef + a951be1
commit d5c1558
Show file tree

Hide file tree

Showing 120 changed files with 4,679 additions and 916 deletions.
diff --git a/.github/ISSUE_TEMPLATE/config.yaml b/.github/ISSUE_TEMPLATE/config.yaml
@@ -0,0 +1 @@
+blank_issues_enabled: false
diff --git a/.github/workflows/publish-docs.yml b/.github/workflows/publish-docs.yml
@@ -0,0 +1,43 @@
+name: 'Build doc page'
+on:
+  push:
+    branches: [ main, doc-page ]
+    tags:
+      - "*"
+
+jobs:
+  publish_docs:
+    name: Build the docs using Sphinx and push to gh-pages
+    runs-on: ubuntu-latest
+    env:
+      python-version: 3.8
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: setup python ${{ env.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ env.python-version }}
+      - name: Install Flair dependencies
+        run: pip install -e .
+      - name: Install unittest dependencies
+        run: pip install -r requirements-dev.txt
+      - name: Install doc dependencies
+        run: pip install -r docs/requirements.txt
+      - name: Fetch git tags
+        run: git fetch --tags origin
+      - name: Build docs
+        run: |
+          sphinx-multiversion docs doc_build/
+      - name: Add redirect to stable doc
+        run: |
+          cp assets/redirect.html doc_build/index.html
+          cp assets/redirect.html doc_build/404.html
+          cp assets/README.md doc_build/README.md
+          sed -i "s/\[VERSION\]/$(python -c 'import flair;print(flair.__version__)')/g" doc_build/index.html
+          sed -i "s/\[VERSION\]/$(python -c 'import flair;print(flair.__version__)')/g" doc_build/404.html
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./doc_build
diff --git a/assets/README.md b/assets/README.md
@@ -0,0 +1,6 @@
+# Docs For Flair NLP
+
+This branch is currently under construction.
+
+It will contain the docs for Flair NLP.
+Don't change files, as this branch will be autogenerated using github actions.
diff --git a/assets/redirect.html b/assets/redirect.html
@@ -0,0 +1,9 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Redirecting to https://flairnlp.github.io/</title>
+    <meta charset="utf-8">
+    <meta http-equiv="refresh" content="0; URL=https://flairnlp.github.io/">
+    <link rel="canonical" href="https://flairnlp.github.io/">
+  </head>
+</html>
diff --git a/docs/_static/api.svg b/docs/_static/api.svg
diff --git a/docs/_static/contributing.svg b/docs/_static/contributing.svg
diff --git a/docs/_static/favicon.ico b/docs/_static/favicon.ico
diff --git a/docs/_static/tutorial.svg b/docs/_static/tutorial.svg
diff --git a/docs/_templates/page.html b/docs/_templates/page.html
@@ -0,0 +1,19 @@
+{% extends "!page.html" %}
+{% block body %}
+{% if current_version and latest_version and current_version != latest_version and current_version != release and current_version.name != latest_version.release %}
+<p>
+  <strong>
+    {% if current_version.is_released %}
+        {% if latest_version.release.replace('v', '').split('.') | map('int') | list > current_version.name.replace('v', '').split('.') | map('int') | list  %}
+          You're reading an old version of this documentation.
+          If you want up-to-date information, please have a look at <a href="{{ vpathto(latest_version.name) }}">{{latest_version.name}}</a>.
+        {% endif %}
+    {% else %}
+    You're reading the documentation for a development version.
+    For the latest stable version, please have a look at <a href="{{ vpathto(latest_version.name) }}">{{latest_version.name}}</a>.
+    {% endif %}
+  </strong>
+</p>
+{% endif %}
+{{ super() }}
+{% endblock %}%
diff --git a/docs/_templates/version-switcher.html b/docs/_templates/version-switcher.html
@@ -0,0 +1,30 @@
+{# As the version switcher will only work when JavaScript is enabled, we add it through JavaScript.
+ #}
+<script>
+document.write(`
+  <div class="version-switcher__container dropdown">
+    <button id="versionswitcherbutton" type="button" role="button" class="version-switcher__button btn btn-sm navbar-btn dropdown-toggle" data-bs-toggle="dropdown" aria-haspopup="listbox" aria-controls="versionswitcherlist" aria-label="Version switcher list">
+      {% if current_version.is_released %} {{ current_version.name }} {% if latest_version and item == latest_version %} (stable) {% endif %} {% else %} latest (dev) {% endif %}
+      <span class="caret"></span>
+    </button>
+    <div id="versionswitcherlist" class="version-switcher__menu dropdown-menu list-group-flush py-0" role="listbox" aria-labelledby="versionswitcherbutton">
+    <!-- dropdown will be populated by javascript on page load -->
+    {%- for item in versions|reverse %}
+      <a class="list-group-item list-group-item-action py-1" href="{{ item.url }}" data-version-name="dev" data-version="devdocs">
+      <span>{% if item.is_released %}
+    {{ item.name }}
+      {% if latest_version and item == latest_version %}
+      (stable)
+      {% endif %}
+    {% else %}
+    latest (dev)
+    {% endif %}
+    {% if item == current_version %}
+    [x]
+    {% endif %}</span>
+      </a>
+    {%- endfor %}
+    </div>
+  </div>
+`);
+</script>
diff --git a/docs/_templates/versioning.html b/docs/_templates/versioning.html
@@ -0,0 +1,17 @@
+{% if versions %}
+<h3>{{ _('Versions') }}</h3>
+<ul>
+  {%- for item in versions|reverse %}
+  <li><a href="{{ item.url }}">
+    {% if item.is_released %}
+    {{ item.name }}
+      {% if latest_version and item == latest_version %}
+      (stable)
+      {% endif %}
+    {% else %}
+    latest ({{ item.name }})
+    {% endif %}
+  </a></li>
+  {%- endfor %}
+</ul>
+{% endif %}
diff --git a/docs/api/datasets/base.rst b/docs/api/datasets/base.rst
@@ -0,0 +1,4 @@
+flair.datasets.base
+===================
+
+.. automodule:: flair.datasets.base
diff --git a/docs/api/datasets/biomedical.rst b/docs/api/datasets/biomedical.rst
@@ -0,0 +1,4 @@
+flair.datasets.biomedical
+=========================
+
+.. automodule:: flair.datasets.biomedical
diff --git a/docs/api/datasets/document_classification.rst b/docs/api/datasets/document_classification.rst
@@ -0,0 +1,4 @@
+flair.datasets.document_classification
+======================================
+
+.. automodule:: flair.datasets.document_classification
diff --git a/docs/api/datasets/entity_linking.rst b/docs/api/datasets/entity_linking.rst
@@ -0,0 +1,4 @@
+flair.datasets.entity_linking
+=============================
+
+.. automodule:: flair.datasets.entity_linking
diff --git a/docs/api/datasets/ocr.rst b/docs/api/datasets/ocr.rst
@@ -0,0 +1,4 @@
+flair.datasets.ocr
+==================
+
+.. automodule:: flair.datasets.ocr
diff --git a/docs/api/datasets/relation_extraction.rst b/docs/api/datasets/relation_extraction.rst
@@ -0,0 +1,4 @@
+flair.datasets.relation_extraction
+==================================
+
+.. automodule:: flair.datasets.relation_extraction
diff --git a/docs/api/datasets/sequence_labeling.rst b/docs/api/datasets/sequence_labeling.rst
@@ -0,0 +1,4 @@
+flair.datasets.sequence_labeling
+================================
+
+.. automodule:: flair.datasets.sequence_labeling
diff --git a/docs/api/datasets/text_image.rst b/docs/api/datasets/text_image.rst
@@ -0,0 +1,4 @@
+flair.datasets.text_image
+=========================
+
+.. automodule:: flair.datasets.text_image
diff --git a/docs/api/datasets/text_text.rst b/docs/api/datasets/text_text.rst
@@ -0,0 +1,4 @@
+flair.datasets.text_text
+=========================
+
+.. automodule:: flair.datasets.text_text
diff --git a/docs/api/datasets/treebanks.rst b/docs/api/datasets/treebanks.rst
@@ -0,0 +1,4 @@
+flair.datasets.treebanks
+========================
+
+.. automodule:: flair.datasets.treebanks
diff --git a/docs/api/embeddings/base.rst b/docs/api/embeddings/base.rst
@@ -0,0 +1,4 @@
+flair.embeddings.base
+=====================
+
+.. automodule:: flair.embeddings.base
diff --git a/docs/api/embeddings/document.rst b/docs/api/embeddings/document.rst
@@ -0,0 +1,4 @@
+flair.embeddings.document
+=========================
+
+.. automodule:: flair.embeddings.document
diff --git a/docs/api/embeddings/image.rst b/docs/api/embeddings/image.rst
@@ -0,0 +1,4 @@
+flair.embeddings.image
+======================
+
+.. automodule:: flair.embeddings.image
diff --git a/docs/api/embeddings/legacy.rst b/docs/api/embeddings/legacy.rst
@@ -0,0 +1,8 @@
+flair.embeddings.legacy
+============================
+
+.. warning::
+   All embeddings in `flair.embeddings.legacy` are considered deprecated.
+   there is no guarantee that they are still working and we recommend using different embeddings instead.
+
+.. automodule:: flair.embeddings.legacy
diff --git a/docs/api/embeddings/token.rst b/docs/api/embeddings/token.rst
@@ -0,0 +1,4 @@
+flair.embeddings.token
+======================
+
+.. automodule:: flair.embeddings.token
diff --git a/docs/api/embeddings/transformer.rst b/docs/api/embeddings/transformer.rst
@@ -0,0 +1,4 @@
+flair.embeddings.transformer
+============================
+
+.. automodule:: flair.embeddings.transformer
diff --git a/docs/api/flair.data.rst b/docs/api/flair.data.rst
@@ -0,0 +1,4 @@
+flair.data
+==========
+
+.. automodule:: flair.data
diff --git a/docs/api/flair.datasets.rst b/docs/api/flair.datasets.rst
@@ -0,0 +1,8 @@
+flair.datasets
+==============
+
+.. toctree::
+   :glob:
+   :maxdepth: 2
+
+   datasets/*
diff --git a/docs/api/flair.embeddings.rst b/docs/api/flair.embeddings.rst
@@ -0,0 +1,8 @@
+flair.embeddings
+================
+
+.. toctree::
+   :glob:
+   :maxdepth: 2
+
+   embeddings/*
diff --git a/docs/api/flair.models.rst b/docs/api/flair.models.rst
@@ -0,0 +1,4 @@
+flair.models
+============
+
+.. automodule:: flair.models
diff --git a/docs/api/flair.nn.rst b/docs/api/flair.nn.rst
@@ -0,0 +1,4 @@
+flair.nn
+========
+
+.. automodule:: flair.nn
diff --git a/docs/api/flair.rst b/docs/api/flair.rst
@@ -0,0 +1,4 @@
+flair
+=====
+
+.. automodule:: flair
diff --git a/docs/api/flair.splitter.rst b/docs/api/flair.splitter.rst
@@ -0,0 +1,4 @@
+flair.splitter
+==============
+
+.. automodule:: flair.splitter
diff --git a/docs/api/flair.tokenization.rst b/docs/api/flair.tokenization.rst
@@ -0,0 +1,4 @@
+flair.tokenization
+==================
+
+.. automodule:: flair.tokenization
diff --git a/docs/api/flair.trainers.plugins.rst b/docs/api/flair.trainers.plugins.rst
@@ -0,0 +1,4 @@
+flair.trainers.plugins
+======================
+
+.. automodule:: flair.trainers.plugins
diff --git a/docs/api/flair.trainers.rst b/docs/api/flair.trainers.rst
@@ -0,0 +1,4 @@
+flair.trainers
+==============
+
+.. automodule:: flair.trainers
diff --git a/docs/api/index.rst b/docs/api/index.rst
@@ -0,0 +1,9 @@
+API Docs
+========
+
+.. toctree::
+   :glob:
+   :maxdepth: 2
+
+   flair
+   flair.*