From f0e071da1d3c6be226b9047ad3033891b2b6d826 Mon Sep 17 00:00:00 2001 From: Carl Gay Date: Sat, 23 Mar 2024 02:23:47 -0400 Subject: [PATCH 1/4] doc: Use furo theme when doc built stand-alone --- documentation/source/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/source/conf.py b/documentation/source/conf.py index 6d4d8df..a426081 100644 --- a/documentation/source/conf.py +++ b/documentation/source/conf.py @@ -48,7 +48,7 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = 'alabaster' +html_theme = 'furo' # html_theme = dylan_themes.get_html_theme_default() # Add any paths that contain custom static files (such as style sheets) here, From d19cd376e2d8e4dca7a0728258e2bfdc773104ca Mon Sep 17 00:00:00 2001 From: Carl Gay Date: Sat, 23 Mar 2024 02:24:15 -0400 Subject: [PATCH 2/4] doc: don't use headings for items that should never be in the ToC Namely "Options:" and "Example:" --- documentation/source/index.rst | 24 +++++++++--------------- 1 file changed, 9 insertions(+), 15 deletions(-) diff --git a/documentation/source/index.rst b/documentation/source/index.rst index e7e5ce1..d8627f4 100644 --- a/documentation/source/index.rst +++ b/documentation/source/index.rst @@ -1,8 +1,8 @@ .. highlight:: shell -************ -`dylan` Tool -************ +************** +``dylan`` Tool +************** The :program:`dylan` command-line tool @@ -452,8 +452,7 @@ status. (Requires an Open Dylan release later than 2020.1.) :program:`dylan-compiler` directly instead, after changing to the workspace top-level directory. -Options: -~~~~~~~~ +**Options:** ``--all`` Build all libraries found in the active packages of the current workspace. @@ -576,8 +575,7 @@ the new dependencies and update the registry files. **See also:** `dylan new application`_ -Options: -~~~~~~~~ +**Options:** ``--force-package``, ``-p`` Create :file:`dylan-package.json` even if already inside a package. This is @@ -612,8 +610,7 @@ Synopsis: ``dylan new workspace [options] `` found. Explicit workspaces are mainly needed when working on multiple interrelated packages at the same time. -Options: -~~~~~~~~ +**Options:** ``--directory`` Create the workspace under this directory instead of in the current working @@ -707,15 +704,13 @@ Display the status of the current workspace. Synopsis: ``dylan status`` -Options: -~~~~~~~~ +**Options:** ``--directory`` Only show the workspace directory and skip showing the active packages. This is intended for use by tooling. -Example: -~~~~~~~~ +**Example:** :: @@ -765,8 +760,7 @@ performs two actions: files that specify ``Platforms: win32`` will not cause a registry file to be generated. -Example: -~~~~~~~~ +**Example:** Create a workspace named ``dt``, with one active package, "dylan-tool", update it, and build the test suite:: From 7b0da4f61cc0e74dfc0aba55b4b196b20361e0a8 Mon Sep 17 00:00:00 2001 From: Carl Gay Date: Sat, 23 Mar 2024 02:25:14 -0400 Subject: [PATCH 3/4] doc: remove local ToC from pacman page --- documentation/source/pacman.rst | 3 --- 1 file changed, 3 deletions(-) diff --git a/documentation/source/pacman.rst b/documentation/source/pacman.rst index 7a07db7..1f73acb 100644 --- a/documentation/source/pacman.rst +++ b/documentation/source/pacman.rst @@ -11,9 +11,6 @@ This documentation describes the package model and how versioned dependencies are resolved. Users generally manage workspaces and packages via `the dylan command`_. -.. contents:: - :depth: 2 - Packages ======== From ead39eea1ab9bcf6ec82136447fe8cc8ae821751 Mon Sep 17 00:00:00 2001 From: Carl Gay Date: Sat, 23 Mar 2024 02:41:26 -0400 Subject: [PATCH 4/4] doc: hide the inline ToC, update intro text --- documentation/source/index.rst | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/documentation/source/index.rst b/documentation/source/index.rst index d8627f4..0e8e7d5 100644 --- a/documentation/source/index.rst +++ b/documentation/source/index.rst @@ -4,19 +4,21 @@ ``dylan`` Tool ************** -The :program:`dylan` command-line tool +The :program:`dylan` command-line tool is intended to make Dylan development +easier by taking care of some of the drudgery for you, including: -* manages Dylan workspaces and package dependencies, -* generates the "registry" files for you, -* eliminates the need to use Git submodules to track dependencies, and -* publishes packages to the Dylan package catalog. +* managing Dylan workspaces and package dependencies +* creating boilerplate for new projects +* downloading and installing dependencies (no need for git submodules) +* generating "registry" files +* publishing packages to the Dylan package catalog .. toctree:: :maxdepth: 2 + :hidden: The pacman Package Manager - Terminology ===========