Skip to content

Commit

Permalink
remove readme from front page of docs
Browse files Browse the repository at this point in the history
make target updates version in readme
  • Loading branch information
iandennismiller committed Jul 2, 2023
1 parent 7ef1696 commit a81ca45
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 8 deletions.
5 changes: 5 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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
8 changes: 4 additions & 4 deletions Readme.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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``.

Expand Down Expand Up @@ -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.

Expand All @@ -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.

Expand All @@ -170,7 +170,7 @@ Other Gthnk Resources
- `Python Package Index <https://pypi.org/project/gthnk/>`_
- `Presentation: Overview of Gthnk <https://iandennismiller.github.io/pres-gthnk-overview>`_ - `presentation repo <https://github.com/iandennismiller/pres-gthnk-overview>`_
- `Continuous Integration <https://travis-ci.org/iandennismiller/gthnk>`_
- `VS Code Extension <https://marketplace.visualstudio.com/items?itemName=IanDennisMiller.gthnk>`_ - `repo <https://github.com/iandennismiller/vscode-gthnk>`_
- `VS Code Extension <https://marketplace.visualstudio.com/items?itemName=IanDennisMiller.gthnk>`_ - `vsc extension repo <https://github.com/iandennismiller/vscode-gthnk>`_
- `Chrome App <https://github.com/iandennismiller/gthnk/tree/master/share/chrome-app>`_
- `Python-Markdown gthnk journal Extension <https://pypi.org/project/mdx_journal/>`_ - `mdx_journal repo <https://github.com/iandennismiller/mdx_journal>`_

Expand Down
9 changes: 8 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
@@ -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
------------
Expand Down
6 changes: 5 additions & 1 deletion src/dev.mk
Original file line number Diff line number Diff line change
Expand Up @@ -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/*

Expand Down
2 changes: 0 additions & 2 deletions src/docker.mk
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# gthnk

GTHNK_VER=$(word 3, $(shell grep __version__ src/gthnk/__meta__.py))

DOCKER_CMD=docker run \
-it \
--rm \
Expand Down

0 comments on commit a81ca45

Please sign in to comment.