Merge pull request #604 from graphistry/dev/readme-redux

Dev/readme redux

.readthedocs.yml

@@ -24,6 +24,10 @@ build:
     # setup
     - pip install ".[docs]"
     - cp -r demos docs/source/demos
+    - cp README.md docs/source/README.md
+    - cp ARCHITECTURE.md docs/source/ARCHITECTURE.md
+    - cp CONTRIBUTE.md docs/source/CONTRIBUTE.md
+    - cp DEVELOP.md docs/source/DEVELOP.md
 
     # build html
     - sphinx-build -b html -d docs/doctrees docs/source $READTHEDOCS_OUTPUT/html/

CHANGELOG.md

@@ -7,6 +7,25 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 ## [Development]
 
+## [0.34.16 - 2024-10-13]
+
+### Docs
+
+* Update and streamline readme.md
+* Add quicksheet for overall
+* More crosslinking
+
+### Infra
+
+* Add markdown support to docsite
+* ReadTheDocs homepage reuses github README.md
+* Docs pip install caches
+* Drop SVGs and external images during latexpdf generation
+
+### Changed
+
+* Treemap import `squarify` deferred to use to allow core import without squarify installed, such as in `--no-deps`
+
 ## [0.34.15 - 2024-10-11]
 
 ### Docs

docs/docker/Dockerfile

@@ -17,14 +17,21 @@ RUN --mount=type=cache,target=/var/cache/apt \
 COPY ../../setup.py ../../setup.cfg ../../versioneer.py ../../README.md ./
 
 # Step 3: Install the project dependencies with pip, including docs extras
-RUN python3 -m pip install --no-cache-dir -e .[docs]
+RUN --mount=type=cache,target=/root/.cache/pip \
+    python3 -m pip install -e .[docs]
 
 # Step 4: Copy the graphistry source files into the container
 COPY ../../graphistry /graphistry
 ENV PYTHONPATH="/graphistry:${PYTHONPATH}"
 
 # Step 5: Copy the build script into the container
 COPY docs/docker/build-docs.sh /build-docs.sh
+COPY docs/source /docs/source
+COPY demos /docs/source/demos
+COPY README.md /docs/source/README.md
+COPY ARCHITECTURE.md /docs/source/ARCHITECTURE.md
+COPY CONTRIBUTE.md /docs/source/CONTRIBUTE.md
+COPY DEVELOP.md /docs/source/DEVELOP.md
 
 # Step 6: Set the working directory for Sphinx to the `source/` folder
 WORKDIR /docs/source

docs/docker/docker-compose.yml

@@ -1,11 +1,11 @@
 services:
   sphinx:
     build:
-      context: ../..  # Use project root as context
-      dockerfile: docs/docker/Dockerfile  # Specify the Dockerfile
+      context: ../..  # project root
+      dockerfile: docs/docker/Dockerfile
     volumes:
-      - ../../docs/source:/docs/source  # Mount the `docs/source` folder to allow live editing
-      - ../../demos:/docs/source/demos  # Mount the `demos` folder for live editing
+      #- ../../docs/source:/docs/source  # Mount the `docs/source` folder to allow live editing
+      #- ../../demos:/docs/source/demos  # Mount the `demos` folder for live editing
       - ../../docs/_build:/docs/_build  # Mount the Sphinx build output to a directory on the host
       - ../../docs/doctrees:/docs/doctrees  # Mount doctrees to persist build state
     environment:

docs/requirements-system.txt

@@ -1,3 +1,4 @@
+inkscape
 pandoc
 texlive-latex-base
 texlive-latex-recommended