From 94cd351a4cb23c1733967411e8e79ce8926d1cfa Mon Sep 17 00:00:00 2001 From: Marc Lichtman Date: Wed, 11 Sep 2024 17:54:18 -0400 Subject: [PATCH 1/3] Update README.md --- docs/README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/README.md b/docs/README.md index 35b7f167..81efbcdd 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,5 +1,6 @@ To build docs: - - create an environment using the ``requirements.txt`` file in this directory - - run ``make`` in this directory - - find the docs is "./build/html", probably starting with file "index.html" + - `cd docs` + - create an environment using the `requirements.txt` file in this directory, e.g., `pip install -r requirements.txt` + - run `make html` + - open `/build/html/index.html` From 63a3ca65b17462bd4fc0278b2cde20283fc5a347 Mon Sep 17 00:00:00 2001 From: Marc Lichtman Date: Wed, 11 Sep 2024 17:55:23 -0400 Subject: [PATCH 2/3] Update conf.py --- docs/source/conf.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 1d5ad92f..23d479cd 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -21,7 +21,8 @@ project = 'kerchunk' copyright = '2021, Martin Durant' author = 'Martin Durant' -version = kerchunk.__version__ +# No easy way to get the latest version based on how the github pages are built/deployed, so leave it blank or else it will be 9999 +version = '' # -- General configuration --------------------------------------------------- From 826ed1b0ef9ea31e67081b9d1e37702efbe5999c Mon Sep 17 00:00:00 2001 From: Martin Durant Date: Wed, 11 Sep 2024 22:24:08 -0400 Subject: [PATCH 3/3] Update docs/README.md --- docs/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index 81efbcdd..bf222fe6 100644 --- a/docs/README.md +++ b/docs/README.md @@ -3,4 +3,4 @@ To build docs: - `cd docs` - create an environment using the `requirements.txt` file in this directory, e.g., `pip install -r requirements.txt` - run `make html` - - open `/build/html/index.html` + - open `build/html/index.html`