From da0a859d5503098ecfd2ae3d890d1ad073929221 Mon Sep 17 00:00:00 2001 From: Brad Bell Date: Mon, 9 Dec 2024 08:33:41 -0700 Subject: [PATCH] master: get_config_dict.py: fix discussion of default. --- pyproject.toml | 2 +- setup.py | 2 +- test_rst/2024.rst | 12 +++++++++++- test_rst/config_file.rst | 4 ++-- user/2024.xrst | 8 ++++++++ xrst/get_conf_dict.py | 4 ++-- xrst/run_xrst.py | 2 +- 7 files changed, 26 insertions(+), 8 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index d4a4ff9f..0eed9d22 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -11,7 +11,7 @@ build-backend = 'setuptools.build_meta' # ----------------------------------------------------------------------------- [project] name = 'xrst' -version = '2024.12.8' +version = '2024.12.9' description = 'Extract RST files from source code and run Sphinx' readme = 'readme.md' requires-python = '>=3.0' diff --git a/setup.py b/setup.py index ce60e734..1c953931 100644 --- a/setup.py +++ b/setup.py @@ -8,7 +8,7 @@ setup( name = 'xrst', - version = '2024.12.8', + version = '2024.12.9', description = 'Extract RST files from source code and run Sphinx', license = 'GPL-3.0-or-later', keywords = 'sphinx rst documentation source', diff --git a/test_rst/2024.rst b/test_rst/2024.rst index 6d53068d..8fe40f62 100644 --- a/test_rst/2024.rst +++ b/test_rst/2024.rst @@ -5,7 +5,7 @@ !!!! .. meta:: - :keywords: 2024,xrst,release,notes,for,mm-dd,12-08,12-01,11-30,11-27,10-25,10-01,09-09,08-25,08-13,08-12,06-25,04-30,04-06,04-05,03-30,03-29,03-28,03-19,03-16,03-04,03-02,03-01,02-29,02-25,02-14,02-03,01-29,01-21,01-04,01-01 + :keywords: 2024,xrst,release,notes,for,mm-dd,12-09,12-08,12-01,11-30,11-27,10-25,10-01,09-09,08-25,08-13,08-12,06-25,04-30,04-06,04-05,03-30,03-29,03-28,03-19,03-16,03-04,03-02,03-01,02-29,02-25,02-14,02-03,01-29,01-21,01-04,01-01 .. index:: 2024, xrst, release, notes, 2024 @@ -24,6 +24,16 @@ xrst Release Notes for 2024 mm-dd ***** +.. _2024@mm-dd@12-09: + +12-09 +===== +Correct comment about the example +:ref:`config_file@directory@project_directory` . +To be specific, it is relative to where the +:ref:`run_xrst@config_file` is located +(which may not be the directory where the xrst is run). + .. _2024@mm-dd@12-08: 12-08 diff --git a/test_rst/config_file.rst b/test_rst/config_file.rst index fcae513f..22e79d35 100644 --- a/test_rst/config_file.rst +++ b/test_rst/config_file.rst @@ -141,8 +141,8 @@ and placed in the *rst_directory*. Default ======= -Note that '.' denotes the directory where -:ref:`xrst ` is run. +Note that ``'.'`` below denotes the directory where the +:ref:`run_xrst@config_file` is located. .. literalinclude:: ../../xrst/get_conf_dict.py :lines: 125-129 diff --git a/user/2024.xrst b/user/2024.xrst index 3c2ec775..1b326208 100644 --- a/user/2024.xrst +++ b/user/2024.xrst @@ -27,6 +27,14 @@ xrst Release Notes for 2024 mm-dd ***** +12-09 +===== +Correct comment about the example +:ref:`config_file@directory@project_directory` . +To be specific, it is relative to where the +:ref:`run_xrst@config_file` is located +(which may not be the directory where the xrst is run). + 12-08 ===== The suspend comment :ref:`suspend_cmd@left, right` syntax was extended diff --git a/xrst/get_conf_dict.py b/xrst/get_conf_dict.py index 3e56fee6..b3d0b069 100644 --- a/xrst/get_conf_dict.py +++ b/xrst/get_conf_dict.py @@ -118,8 +118,8 @@ def system_exit(msg) : Default ======= -Note that '.' denotes the directory where -:ref:`xrst ` is run. +Note that ``'.'`` below denotes the directory where the +:ref:`run_xrst@config_file` is located. {xrst_code toml} [directory] diff --git a/xrst/run_xrst.py b/xrst/run_xrst.py index 2cad87d3..410ae77c 100644 --- a/xrst/run_xrst.py +++ b/xrst/run_xrst.py @@ -626,7 +626,7 @@ def fix_latex(latex_dir, project_name) : import xrst # # version -version = '2024.12.8' +version = '2024.12.9' # def run_xrst() : #