clean up build files

.github/ISSUE_TEMPLATE.md

@@ -1,4 +1,4 @@
-* networkframe version:
+* `networkframe` version:
 * Python version:
 * Operating System:
 

.github/workflows/dev.yml

@@ -1,14 +1,13 @@
-# This is a basic workflow to help you get started with Actions
-
+# Run tests and linting
 name: dev workflow
 
 # Controls when the action will run.
 on:
   # Triggers the workflow on push or pull request events but only for the master branch
   push:
-    branches: [master, main]
+    branches: [main]
   pull_request:
-    branches: [master, main]
+    branches: [main]
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
@@ -20,7 +19,7 @@ jobs:
     # The type of runner that the job will run on
     strategy:
       matrix:
-        python-versions: [3.11]
+        python-versions: [3.11, 3.12]
         os: [ubuntu-latest, macos-latest, windows-latest]
     runs-on: ${{ matrix.os }}
 
@@ -47,6 +46,4 @@ jobs:
         run: tox --version
 
       - name: run tox
-        run: tox -vvv
-      # - name: pytest
-      #   run: pytest -vvv
+        run: tox -vv

docs/installation.md

@@ -2,42 +2,48 @@
 
 ## Stable release
 
-To install networkframe, run this command in your
+To install `networkframe`, run this command in your
 terminal:
 
-``` console
-$ pip install networkframe
+```console
+pip install networkframe
 ```
 
-This is the preferred method to install networkframe, as it will always install the most recent stable release.
+This is the preferred method to install `networkframe`, as it will always install the most recent stable release.
 
 If you don't have [pip][] installed, this [Python installation guide][]
 can guide you through the process.
 
 ## From source
 
-The source for networkframe can be downloaded from
+The source for `networkframe` can be downloaded from
 the [Github repo][].
 
 You can either clone the public repository:
 
-``` console
-$ git clone git://github.com/bdpedigo/networkframe
+```console
+git clone git://github.com/bdpedigo/networkframe
 ```
 
 Or download the [tarball][]:
 
-``` console
-$ curl -OJL https://github.com/bdpedigo/networkframe/tarball/master
+```console
+curl -OJL https://github.com/bdpedigo/networkframe/tarball/master
 ```
 
 Once you have a copy of the source, you can install it with:
 
-``` console
-$ pip install .
+```console
+pip install .
 ```
 
-  [pip]: https://pip.pypa.io
-  [Python installation guide]: http://docs.python-guide.org/en/latest/starting/installation/
-  [Github repo]: https://github.com/%7B%7B%20cookiecutter.github_username%20%7D%7D/%7B%7B%20cookiecutter.project_slug%20%7D%7D
-  [tarball]: https://github.com/%7B%7B%20cookiecutter.github_username%20%7D%7D/%7B%7B%20cookiecutter.project_slug%20%7D%7D/tarball/master
+Or in editable mode, it can be installed with:
+
+```console
+pip install -e .
+```
+
+[pip]: https://pip.pypa.io
+[Python installation guide]: http://docs.python-guide.org/en/latest/starting/installation/
+[Github repo]: https://github.com/bdpedigo/networkframe
+[tarball]: https://github.com/bdpedigo/networkframe/tarball/main

docs/usage.md

@@ -1,6 +1,6 @@
 # Usage
 
-To use networkframe in a project
+To use `networkframe` in a project
 
 ```
 import networkframe

mkdocs.yml

@@ -1,6 +1,6 @@
 site_name: networkframe
-site_url: https://bdpedigo.github.io/networkframe
-repo_url: https://github.com/bdpedigo/networkframe
+site_url: https://bdpedigo.github.io/networkframe/
+repo_url: https://github.com/bdpedigo/networkframe/
 repo_name: bdpedigo/networkframe
 #strict: true
 nav:
@@ -51,13 +51,18 @@ plugins:
         python:
           rendering:
             show_source: true
+
 extra:
   social:
     - icon: fontawesome/brands/github
       link: https://github.com/bdpedigo/networkframe
       name: Github
     - icon: material/email
       link: "mailto:[email protected]"
+  extra:
+    version:
+      provider: mike
+
   # to enable disqus, uncomment the following and put your disqus id below
   # disqus: disqus_id
 # uncomment the following and put your google tracking id below to enable GA

pyproject.toml

@@ -38,6 +38,7 @@ pymdown-extensions = "^10.5"
 pytest = "^7.4.3"
 ruff = "^0.1.7"
 twine = "^4.0.2"
+mike = "^2.0.0"
 
 [build-system]
 build-backend = "poetry.masonry.api"