Merge pull request #191 from radinamatic/404-for-0.5

Add 404 page to v0.5 branch
learningequality · Aug 26, 2020 · 2cff197 · 2cff197
2 parents e7ab683 + 4bc3255
commit 2cff197
Show file tree

Hide file tree

Showing 7 changed files with 35 additions and 8 deletions.
diff --git a/docs/404.rst b/docs/404.rst
@@ -0,0 +1,17 @@
+:orphan:
+
+Page not found
+==============
+
+It seems you are searching for a topic that has been moved elsewhere in our documentation. Please try the following to find what you were looking for:
+
+* Browse the table of content in the sidebar 
+* Use the search box
+
+
+*Use the upper menu button to open the table of contents if you are on the mobile device.*
+
+.. tip:: Make sure you are browsing the user guide for the `latest release of Kolibri <https://kolibri.readthedocs.io/en/latest/>`_.
+
+
+We apologize for the inconvenience!
diff --git a/docs/_static/theme_overrides.css b/docs/_static/theme_overrides.css
@@ -0,0 +1,7 @@
+
+@import url("https://fonts.googleapis.com/icon?family=Material+Icons");
+
+/* push down the RTD banner so it's not confused with menu */
+.keep-us-sustainable {
+  margin-top: 20em !important;
+}
diff --git a/docs/conf.py b/docs/conf.py
@@ -14,7 +14,7 @@
 # FOR! DO NOT LET THEM BE TARGETTED AT MORE THAN ONE MINOR SERIES!
 # I.E.: 0.1.x -- important to add 'dev' suffix for docs targetting development
 # series.
-DISPLAY_VERSION = "0.5.x"
+DISPLAY_VERSION = "0.5"
 
 
 # If extensions (or modules to document with autodoc) are in another directory,
@@ -24,6 +24,12 @@
 parent = os.path.dirname(cwd)
 sys.path.insert(0, os.path.abspath(parent))
 
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx_rtd_theme',
+    'notfound.extension',
+]
+
 builddir = os.path.join(cwd, '_build')
 
 # -- General configuration -----------------------------------------------------

diff --git a/docs/dev/dataflow.rst b/docs/dev/dataflow.rst
@@ -133,13 +133,9 @@ Collections
 For particular views on a data table (which could range from 'show me everything' to 'show me all content nodes with titles starting with "p"') - Collections are used.
 Collections are a cached view onto the data table, which are populated by Models - so if a Model that has previously been fetched from the server by a Collection is requested from :code:`getModel`, it is already cachced.
 
-.. code-block:: javascript
-  // corresponds to /api/content/<channelId>/contentnode/?popular=1
-  const contentCollection = ContentNodeResource.getCollection({ channel_id: channelId }, { popular: 1 });
-
 The first argument defines any additional required :code:`resourceIdentifiers` that we need to build up the URL, while the second argument defines the GET parameters that are used to define the filters to be applied to the data and hence the subset of the data that the Collection represents.
 
-We now have a reference for a representation of this data on the server. To ensure that it has data from the server, we can call :code:`fetch` on it, this will resolve to an array of the returned data objects
+We now have a reference for a representation of this data on the server. To ensure that it has data from the server, we can call :code:`fetch` on it, this will resolve to an array of the returned data objects.
 
 .. code-block:: javascript
 

diff --git a/docs/dev/index.rst b/docs/dev/index.rst
@@ -44,8 +44,6 @@ References
 .. toctree::
   :maxdepth: 1
 
-  cli
   files
   glossary
   building
-  ../py_modules/modules
diff --git a/docs/user/cli.rst b/docs/user/cli.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 The ``kolibri`` command
 =======================
 

diff --git a/requirements.txt b/requirements.txt
@@ -2,3 +2,4 @@
 sphinx
 sphinx_rtd_theme
 sphinx-intl
+sphinx-notfound-page