From a81ca4509edfe18f59b809c3b246be630debd91e Mon Sep 17 00:00:00 2001 From: Ian Dennis Miller Date: Sun, 2 Jul 2023 07:22:58 -0400 Subject: [PATCH] remove readme from front page of docs make target updates version in readme --- Makefile | 5 +++++ Readme.rst | 8 ++++---- docs/index.rst | 9 ++++++++- src/dev.mk | 6 +++++- src/docker.mk | 2 -- 5 files changed, 22 insertions(+), 8 deletions(-) diff --git a/Makefile b/Makefile index ece16ea..863841b 100644 --- a/Makefile +++ b/Makefile @@ -1,5 +1,7 @@ # gthnk +GTHNK_VER=$(word 3, $(shell grep __version__ src/gthnk/__meta__.py)) + help: @echo The following makefile targets are available: @echo @@ -21,5 +23,8 @@ server: FLASK_APP=src/gthnk_web/app \ flask run +version: + @echo $(GTHNK_VER) + -include src/docker.mk -include src/dev.mk diff --git a/Readme.rst b/Readme.rst index 0abd37c..1d4665b 100644 --- a/Readme.rst +++ b/Readme.rst @@ -42,7 +42,7 @@ Use Docker to run Gthnk with all files stored locally in ``~/.gthnk``. -p 1620:1620 \ -e TZ=America/Toronto \ -v ~/.gthnk:/opt/gthnk/var \ - iandennismiller/gthnk:0.8 + iandennismiller/gthnk:0.8.1 The default text file where you will record journal entries is ``~/.gthnk/journal.txt``. @@ -139,7 +139,7 @@ A complete example using Dropbox could look like: -p 1620:1620 \ -e TZ=America/Toronto \ -v ~/Dropbox/gthnk:/opt/gthnk/var \ - iandennismiller/gthnk:0.8 + iandennismiller/gthnk:0.8.1 This configuration supports running Gthnk on a dedicated server, like a local Linux machine, while editing the journal files on devices that are synced via the cloud. @@ -153,7 +153,7 @@ To support a laptop and phone, use a custom configuration file. -e TZ=America/Toronto \ -v ~/.gthnk/gthnk.conf:/opt/gthnk/.config/gthnk/gthnk.conf \ -v ~/Dropbox/gthnk:/opt/gthnk/var - iandennismiller/gthnk:0.8 + iandennismiller/gthnk:0.8.1 Then edit ``~/.gthnk/gthnk.conf`` to specify multiple INPUT_FILES. @@ -170,7 +170,7 @@ Other Gthnk Resources - `Python Package Index `_ - `Presentation: Overview of Gthnk `_ - `presentation repo `_ - `Continuous Integration `_ -- `VS Code Extension `_ - `repo `_ +- `VS Code Extension `_ - `vsc extension repo `_ - `Chrome App `_ - `Python-Markdown gthnk journal Extension `_ - `mdx_journal repo `_ diff --git a/docs/index.rst b/docs/index.rst index 73911ea..dc13681 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,6 +1,13 @@ .. gthnk documentation master file -.. include:: ../Readme.rst +Overview +-------- + +- **Gthnk** presents a **journal** consisting of many **entries**. +- **Entries** are created using plain old text files, which **Gthnk** imports once per day. +- Any text editor can be used to add information to **Gthnk**. +- **Entries** are searchable using the embedded **Gthnk** server, which can be accessed with a browser. +- Plain-text enables backup/restore via hardcopy (e.g. paper) for long-term archival. Introduction ------------ diff --git a/src/dev.mk b/src/dev.mk index e3c5ed5..496d3a3 100644 --- a/src/dev.mk +++ b/src/dev.mk @@ -26,7 +26,11 @@ docs: pip install -r docs/requirements.txt sphinx-build -b html docs var/sphinx -release: clean +readme: + sed -I .bak -E 's/iandennismiller\/gthnk:.+$$/iandennismiller\/gthnk:$(GTHNK_VER)/g' Readme.rst + rm Readme.rst.bak + +release: clean readme cd src && python setup.py sdist bdist_wheel twine check src/dist/* diff --git a/src/docker.mk b/src/docker.mk index 17aac01..759f61d 100644 --- a/src/docker.mk +++ b/src/docker.mk @@ -1,7 +1,5 @@ # gthnk -GTHNK_VER=$(word 3, $(shell grep __version__ src/gthnk/__meta__.py)) - DOCKER_CMD=docker run \ -it \ --rm \