From a70caeee136cf05c7960bd6631088f87f9d9900c Mon Sep 17 00:00:00 2001 From: Junhao Liao Date: Sun, 24 Nov 2024 21:57:37 -0500 Subject: [PATCH] Docs improvement - Apply suggestions from code review Co-authored-by: kirkrodrigues <2454684+kirkrodrigues@users.noreply.github.com> --- Taskfile.yaml | 1 - docs/README.md | 5 ++--- docs/conf/conf.py | 2 +- 3 files changed, 3 insertions(+), 5 deletions(-) diff --git a/Taskfile.yaml b/Taskfile.yaml index f9958bc7..a8e4aa39 100644 --- a/Taskfile.yaml +++ b/Taskfile.yaml @@ -5,7 +5,6 @@ includes: utils: "tools/yscope-dev-utils/taskfiles/utils.yml" vars: - # Build paths G_BUILD_DIR: "{{.ROOT_DIR}}/build" tasks: diff --git a/docs/README.md b/docs/README.md index 8f3d7207..1638e3d4 100644 --- a/docs/README.md +++ b/docs/README.md @@ -14,9 +14,8 @@ this project: * [Node.js] >= 16 to be able to [view the output](#viewing-the-output) * Python 3.10 or later * [Task] >= 3.38.0 - * We constrain the version because, in lower versions, the Taskfile syntax we use has bugs. -## Build Commands +## Build commands * Build the site incrementally: @@ -32,7 +31,7 @@ this project: task docs:clean ``` -## Viewing the Output +## Viewing the output ```shell task docs:serve diff --git a/docs/conf/conf.py b/docs/conf/conf.py index 50e8b1df..eafd855b 100644 --- a/docs/conf/conf.py +++ b/docs/conf/conf.py @@ -3,7 +3,7 @@ project = "YScope Log Viewer" # NOTE: We don't include a period after "Inc" since the theme adds one already. -copyright = "2021-2024 YScope Inc" +copyright = "2022-2024 YScope Inc" # -- General configuration ----------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration