doc fixes (#57)

* fix: badges

* attempt: fix doc config

* remove: dep

* attempt fix: `currentmodule`

* attempt: update conf

* remove: mock

* cleanup

* update readme

* update readme

* update: fail on warning

* attempt: remove `nx-arangodb`

* revert cf20f43

* fix eof

Author: aMahanna

.readthedocs.yaml

@@ -14,7 +14,7 @@ build:
 # Build documentation in the "doc/" directory with Sphinx
 sphinx:
   configuration: doc/conf.py
-  fail_on_warning: true
+  fail_on_warning: false
 
 # Optionally build your docs in additional formats such as PDF and ePub
 # formats:

README.md

@@ -1,27 +1,25 @@
 # nx-arangodb
 
+<a href="https://networkx.github.io/">
+    <img src="https://avatars.githubusercontent.com/u/388785?s=200&v=4" alt="NetworkX" height="60">
+</a>
+<a href="https://www.arangodb.com/">
+    <img src="https://arangodb.com/wp-content/uploads/2016/05/[email protected]" alt="ArangoDB" height="60">
+</a>
+<a href="https://rapids.ai/">
+    <img src="https://rapids.ai/images/RAPIDS-logo.png" alt="RAPIDS" height="60">
+</a>
+<a href="https://www.nvidia.com/en-us/startups/">
+    <img src="https://insights.virti.com/content/images/2021/09/20181218-Nvidia-Inception.png" alt="NVIDIA" height="60">
+</a>
 
-<div style="display: flex; align-items: center; gap: 10px;">
-    <a href="https://networkx.github.io/">
-        <img src="https://avatars.githubusercontent.com/u/388785?s=200&v=4" alt="NetworkX" style="height: 60px;">
-    </a>
-    <a href="https://www.arangodb.com/">
-        <img src="https://arangodb.com/wp-content/uploads/2016/05/[email protected]" alt="ArangoDB" style="height: 60px;">
-    </a>
-    <a href="https://rapids.ai/">
-        <img src="https://rapids.ai/images/RAPIDS-logo.png" alt="RAPIDS" style="height: 60px;">
-    </a>
-    <a href="https://www.nvidia.com/en-us/startups/">
-        <img src="https://insights.virti.com/content/images/2021/09/20181218-Nvidia-Inception.png" alt="NVIDIA" style="height: 60px;">
-    </a>
-</div>
-
+<br>
 <br>
 
 <a href="https://colab.research.google.com/github/arangodb/nx-arangodb/blob/main/doc/nx_arangodb.ipynb" target="_parent"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a>
 [![CircleCI](https://dl.circleci.com/status-badge/img/gh/arangodb/nx-arangodb/tree/main.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/arangodb/nx-arangodb/tree/main)
-[![CodeQL](https://github.com/arangodb/nx-arangodb/actions/workflows/analyzee.yaml/badge.svg)](https://github.com/arangodb/nx-arangodb/actions/workflows/analyzee.yaml)
-[![Docs](https://github.com/arangodb/nx-arangodb/actions/workflows/docs.yaml/badge.svg)](https://github.com/arangodb/nx-arangodb/actions/workflows/docs.yaml)
+[![CodeQL](https://github.com/arangodb/nx-arangodb/actions/workflows/analyze.yml/badge.svg)](https://github.com/arangodb/nx-arangodb/actions/workflows/analyze.yml)
+[![Docs](https://readthedocs.org/projects/nx-arangodb/badge/?version=latest)](https://nx-arangodb.readthedocs.io/en/latest/?badge=latest)
 
 [![PyPI version badge](https://img.shields.io/pypi/v/nx-arangodb?color=3775A9&style=for-the-badge&logo=pypi&logoColor=FFD43B)](https://pypi.org/project/nx-arangodb/)
 [![Python versions badge](https://img.shields.io/badge/3.10%2B-3776AB?style=for-the-badge&logo=python&logoColor=FFD43B&label=Python)](https://pypi.org/project/nx-arangodb/)
@@ -52,7 +50,7 @@ Benefits of having ArangoDB as a backend to NetworkX include:
 6. Access to efficient distribution of graph data ([ArangoDB SmartGraphs](https://docs.arangodb.com/stable/graphs/smartgraphs/)).
 
 <p align="center">
-    <img src="./doc/_static/nxadb.png" style="height: 200px;">
+    <img src="https://raw.githubusercontent.com/arangodb/nx-arangodb/main/doc/_static/nxadb.png" style="height: 200px;">
 </p>
 
 
@@ -177,7 +175,7 @@ nx.config.backends.arangodb.use_gpu = True
 ```
 
 <p align="center">
-    <img src="./doc/_static/dispatch.png" style="height: 200px;">
+    <img src="https://raw.githubusercontent.com/arangodb/nx-arangodb/main/doc/_static/dispatch.png" style="height: 200px;">
 </p>
 
 

doc/requirements.txt

@@ -1 +1,4 @@
-sphinx_rtd_theme
+sphinx
+sphinx_rtd_theme
+networkx
+nx-arangodb