Use includes so the README matches the docs index

pydanny · Oct 30, 2023 · 63e9142 · 63e9142
1 parent 071032e
commit 63e9142
Show file tree

Hide file tree

Showing 6 changed files with 16 additions and 44 deletions.
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -6,10 +6,7 @@ build:
     python: "3.10"
   jobs:
     pre_build:
-      # Generate the Sphinx configuration for this Jupyter Book so it builds.
-      - "pip install -r docs/requirements.txt"
-      - "pip install ."
-      - pip install "mkdocs-material[imaging]"
+      - "pip install '.[docs]'"
       - "mkdocs build"
 
 mkdocs:

diff --git a/README.md b/README.md
@@ -14,6 +14,8 @@ Full documentation available at [dj-notebook](https://dj-notebook.readthedocs.io
 
 ## Features
 
+The ever-growing list of features:
+
 - Easy ipython notebooks with Django
 - Built-in integration with the imported objects from django-extensions
 - Inheritance diagrams on any object, including ORM models
@@ -89,12 +91,12 @@ Generates this image
 plus.read_frame(plus.User.objects.all())
 ```
 
-## Check out the official documentation for more things you can do!
+## More things you can do!
 
 [dj-notebook official documentation](https://dj-notebook.readthedocs.io/)
 
 
-# Contributors
+## Contributors
 
 <!-- readme: contributors -start -->
 <table>

diff --git a/docs/index.md b/docs/index.md
@@ -1,36 +1,7 @@
 # Home
 
-![dj-notebook logo](img/dj-notebook-logo.png)
-
-_Django + shell_plus + Jupyter notebooks made easy_
-
-A Jupyter notebook with access to objects from the Django ORM is a powerful tool to introspect data and run ad-hoc queries.
-
-## Features
-
-The ever-growing list of features:
-
-- Easy ipython notebooks with Django
-- Built-in integration with the imported objects from django-extensions
-- Inheritance diagrams on any object, including ORM models
-- Converts any Django QuerySet to Pandas Dataframe
-- Handy function for displaying mermaid charts in 
-- Generates visual maps of model relations
-
-## Examples
-
-```python
-from dj_notebook import activate
-plus = activate()
-plus.User.objects.all()
-```
-
-```
-<QuerySet [<User: Audrey>, <User: Daniel>]>
-```
-
-!!! tip "Full Usage"
-
-    Learn how to use all the awesome features of dj-notebook in the [usage page](./usage)!
-
-
+{%
+   include-markdown "../README.md"
+   start="<!--intro-start-->"
+   end="<!--intro-end-->"
+%}
diff --git a/docs/requirements.txt b/docs/requirements.txt
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -22,10 +22,12 @@ plugins:
           remove_tag_config:
               remove_input_tags:
                   - hide_code
+    - include-markdown:
+          start: <!--start-->
+          end: <!--end-->                    
     - search
     - social    
 
-
 nav:
   - Introduction: index.md
   - Installation:

diff --git a/pyproject.toml b/pyproject.toml
@@ -54,7 +54,9 @@ test = [
 ]
 docs = [
   "mkdocs-material",
-  "mkdocs-jupyter"
+  "mkdocs-jupyter",
+  "mkdocs-material[imaging]",
+  "mkdocs-include-markdown-plugin"  
 ]
 
 [project.urls]