From ba5a81002897424e3290b6b93fbec1e13a013fdc Mon Sep 17 00:00:00 2001 From: Carl Gay Date: Thu, 16 May 2024 00:16:40 -0400 Subject: [PATCH] doc: fix build and linkcheck errors --- .../source/about/examples/hello_world.rst | 8 ++-- .../source/about/examples/macros.rst | 3 +- documentation/source/articles/beyond-java.rst | 18 ++++---- .../articles/procedural-dylan/1-distance.rst | 3 +- .../articles/procedural-dylan/2-quadratic.rst | 2 +- .../procedural-dylan/3-dot-product.rst | 3 +- .../articles/procedural-dylan/index.rst | 17 ++++---- .../source/building-with-duim/callbacks.rst | 30 +++++++------ .../source/building-with-duim/commands.rst | 12 +++--- .../source/building-with-duim/design.rst | 4 +- .../source/building-with-duim/improve.rst | 40 ++++++++++-------- .../source/building-with-duim/menus.rst | 12 +++--- .../source/building-with-duim/source.rst | 17 ++++---- .../source/building-with-duim/tour.rst | 17 ++++---- .../source/community/gsoc/2012/cocoa.rst | 2 +- .../source/community/gsoc/2012/dispatch.rst | 2 +- .../community/gsoc/2012/project_manager.rst | 4 +- documentation/source/community/index.rst | 4 +- documentation/source/corba-guide/projects.rst | 4 +- .../documentation/cheatsheets/collections.rst | 18 +++----- documentation/source/documentation/index.rst | 42 +++++++++---------- .../source/documentation/publications.rst | 10 ++--- .../source/duim-reference/conventions.rst | 3 +- .../source/duim-reference/frames.rst | 23 ++++------ .../source/duim-reference/gadgets.rst | 6 ++- .../getting-started-cli/cross-compilation.rst | 6 +-- .../debugging-with-gdb-lldb.rst | 3 +- .../dylan-mode-for-emacs.rst | 3 +- .../getting-started-cli/editor-support.rst | 2 +- .../source/getting-started-cli/index.rst | 5 +-- .../getting-started-cli/source-registries.rst | 1 + .../source/getting-started-ide/preface.rst | 4 +- .../source/hacker-guide/build-system.rst | 4 +- .../hacker-guide/documentation/doctower.rst | 2 +- .../hacker-guide/documentation/example.rst | 2 +- .../hacker-guide/documentation/index.rst | 2 +- documentation/source/hacker-guide/index.rst | 13 +++--- .../runtime-manager/access-path.rst | 14 +++---- .../source/hacker-guide/runtime/startup.rst | 2 +- .../source/hacker-guide/topics/debugging.rst | 6 +-- .../hacker-guide/topics/making-a-release.rst | 7 ++-- .../hacker-guide/topics/method-dispatch.rst | 24 +++++------ documentation/source/history/index.rst | 6 +-- .../intro-dylan/methods-generic-functions.rst | 2 +- .../source/library-reference/c-ffi/index.rst | 2 +- .../common-dylan/common-extensions.rst | 4 +- .../library-reference/common-dylan/index.rst | 2 +- .../library-reference/dylan/finalization.rst | 2 +- .../source/library-reference/index.rst | 2 +- .../source/library-reference/io/streams.rst | 4 +- .../source/library-reference/system/date.rst | 4 +- .../library-reference/system/file-system.rst | 2 +- .../source/man-pages/dylan-compiler.rst | 2 +- .../source/news/2011/12/10/new_release.rst | 2 +- documentation/source/news/2012/01/25/c3.rst | 4 +- .../news/2012/10/15/command-line-parser.rst | 2 +- .../source/news/2012/12/20/new-release.rst | 6 +-- .../source/news/2013/07/11/new-release.rst | 2 +- .../source/news/2013/08/15/duim-gtk.rst | 34 +++++++-------- .../source/news/2013/12/23/new-release.rst | 2 +- .../source/news/2015/01/01/new-release.rst | 4 +- .../source/news/2019/03/31/new-release.rst | 9 ++-- .../source/news/2020/10/10/new-release.rst | 9 ++-- .../source/news/2022/11/28/new-release.rst | 9 ++-- documentation/source/news/index.rst | 8 ++-- .../source/proposals/dep-0001-dep-process.rst | 6 +-- .../dep-0006-single-file-library.rst | 4 +- .../proposals/dep-0008-multi-line-strings.rst | 2 +- .../proposals/dep-0010-element-otherwise.rst | 2 +- .../proposals/dep-0012-string-literals.rst | 6 +-- documentation/source/proposals/index.rst | 4 +- documentation/source/release-notes/2011.1.rst | 2 +- documentation/source/release-notes/2012.1.rst | 22 ++++------ documentation/source/release-notes/2013.2.rst | 10 ++--- documentation/source/release-notes/2014.1.rst | 5 +-- documentation/source/release-notes/2019.1.rst | 6 +-- documentation/source/release-notes/2020.1.rst | 26 +++++------- documentation/source/release-notes/2022.1.rst | 17 ++++---- documentation/source/release-notes/2024.2.rst | 8 ++-- documentation/source/style-guide/index.rst | 4 +- 80 files changed, 310 insertions(+), 341 deletions(-) diff --git a/documentation/source/about/examples/hello_world.rst b/documentation/source/about/examples/hello_world.rst index c166ee0143..3f14900ef0 100644 --- a/documentation/source/about/examples/hello_world.rst +++ b/documentation/source/about/examples/hello_world.rst @@ -29,9 +29,11 @@ The canonical "Hello World" program in Dylan. format-out("Hello!\n"); -.. hint:: The `dylan new application `_ - command will create these files for you, along with a test suite and - build files. +.. hint:: The `deft new application + `_ + command (called ``dylan new application`` in Open Dylan 2024.1 and + older releases) will create these files for you, along with a test + suite and build files. How it works ============ diff --git a/documentation/source/about/examples/macros.rst b/documentation/source/about/examples/macros.rst index 6d3723ce3f..e6a28c6ec1 100644 --- a/documentation/source/about/examples/macros.rst +++ b/documentation/source/about/examples/macros.rst @@ -42,6 +42,5 @@ See also: in common-dylan is a simple example of making a new top-level "define" form. * :drm:`Built-in macros ` -- Many of the basic features of Dylan are implemented as macros. -* The `Dylan Macro System `_ article by Dustin - Voss. +* The :doc:`Dylan Macro System ` article by Dustin Voss. * The :drm:`Macros` chapter in the :drm:`DRM `. diff --git a/documentation/source/articles/beyond-java.rst b/documentation/source/articles/beyond-java.rst index 34bd43a7f2..4b54ceab5b 100644 --- a/documentation/source/articles/beyond-java.rst +++ b/documentation/source/articles/beyond-java.rst @@ -18,11 +18,11 @@ The Java Age We have been living through the Java age. It is somewhat of an understatement to say that there has been a great deal of interest in the `Java programming language -`_ +`_ -- although as far as hype goes `XML -`_ is now +`_ is now overshadowing it. Initially Java, outside `Sun Microsystems -`_ at least, was +`_ at least, was seen as a programming language purely for the Internet. In particular, it came with a virtual machine that could be embedded in web browsers and a security model to control the activity of Java programs running in such browsers. @@ -31,12 +31,12 @@ These days, however, Java has moved on and developers are using the language for all sorts of applications. Java is perceived as a reasonable general purpose programming language -- one that is good enough. The tools are evolving. JIT compilers like `Sun's Hotspot -`_ +`_ are making Java code run faster. UML-based design tools like `Rational Rose -`_ +`_ are finding Java's rigid syntax amenable to round-trip engineering. EJB-based Application Servers like `BEA's WebLogic -`_ are providing +`_ are providing the background of services needed for many kinds of business applications. So what's the problem? @@ -71,7 +71,7 @@ Java. This need not mean going back to C++. After all, Java's popularization of garbage collection and pointer-free programming has probably significantly advanced the cause of reliable software. This also does not mean stepping sideways to `C# -`_ +`_ -- a similar language with many of the same problems. The alternative programming language that I'm proposing in this article is @@ -90,12 +90,12 @@ An Example ========== Since, according to `Samuel Johnson -`_, +`_, "example is always more efficacious than precept", I will examine a real programming task that is made more awkward by Java and more elegant by Dylan. In the last few years I've personally been working on some `CORBA -`_ +`_ projects. In particular, I've written compilers in both Dylan and Java for CORBA's Interface Definition Language (IDL), so I feel able to show how a language like Dylan can simplify application development compared to Java. In diff --git a/documentation/source/articles/procedural-dylan/1-distance.rst b/documentation/source/articles/procedural-dylan/1-distance.rst index 65dcab076b..a0d39c27cc 100644 --- a/documentation/source/articles/procedural-dylan/1-distance.rst +++ b/documentation/source/articles/procedural-dylan/1-distance.rst @@ -220,7 +220,6 @@ anywhere inside a body. -------------- -`Next -- Conditions and Multiple Values: The Quadratic -Formula <2-quadratic.html>`_ +:doc:`Next -- Conditions and Multiple Values: The Quadratic Formula <2-quadratic>` Copyright © 1995 Paul Haahr. All rights reserved. diff --git a/documentation/source/articles/procedural-dylan/2-quadratic.rst b/documentation/source/articles/procedural-dylan/2-quadratic.rst index a1e6545db2..9d4f8bbd5b 100644 --- a/documentation/source/articles/procedural-dylan/2-quadratic.rst +++ b/documentation/source/articles/procedural-dylan/2-quadratic.rst @@ -229,6 +229,6 @@ predicates end in question marks, as we can see from ``negative?`` and -------------- -`Back -- A Simple Function: Distance <1-distance.html>`_ | `Next -- Iteration and Sequences: Dot Product <3-dot-product.html>`_ +:doc:`Back -- A Simple Function: Distance <1-distance>` | :doc:`Next -- Iteration and Sequences: Dot Product <3-dot-product>` Copyright © 1995 Paul Haahr. All rights reserved. diff --git a/documentation/source/articles/procedural-dylan/3-dot-product.rst b/documentation/source/articles/procedural-dylan/3-dot-product.rst index 23da429299..1fd1da5c81 100644 --- a/documentation/source/articles/procedural-dylan/3-dot-product.rst +++ b/documentation/source/articles/procedural-dylan/3-dot-product.rst @@ -521,7 +521,6 @@ readable and maintainable. -------------- -`Back -- Conditions and Multiple Values: The Quadratic -Formula <2-quadratic.html>`_ +:doc:`Back -- Conditions and Multiple Values: The Quadratic Formula <2-quadratic>` Copyright © 1995 Paul Haahr. All rights reserved. diff --git a/documentation/source/articles/procedural-dylan/index.rst b/documentation/source/articles/procedural-dylan/index.rst index cab8842615..f852713e20 100644 --- a/documentation/source/articles/procedural-dylan/index.rst +++ b/documentation/source/articles/procedural-dylan/index.rst @@ -3,6 +3,14 @@ Procedural Dylan ================ +.. toctree:: + :hidden: + :maxdepth: 2 + + 1-distance + 2-quadratic + 3-dot-product + or How to write Pascal programs in Dylan ---------------------------------------- @@ -19,13 +27,6 @@ addition to one's bag of tricks. This essay is intended to be used as a tutorial introduction and not as a complete reference work. To avoid bogging down the discussion, much has been omitted and some details have been ignored. For more complete -information, see the `Dylan Reference Manual `__. - -.. toctree:: - :titlesonly: - - 1-distance - 2-quadratic - 3-dot-product +information, see the `Dylan Reference Manual `_. Copyright © 1995 Paul Haahr. All rights reserved. diff --git a/documentation/source/building-with-duim/callbacks.rst b/documentation/source/building-with-duim/callbacks.rst index 8721f6b175..471e0b90d9 100644 --- a/documentation/source/building-with-duim/callbacks.rst +++ b/documentation/source/building-with-duim/callbacks.rst @@ -8,8 +8,7 @@ Adding Callbacks to the Application *********************************** At this point, the task list manager still does very little. If you try -running the code (as described in `Starting the -application `_), and interacting with any of the +running the code (as described in :ref:`starting-the-application`), and interacting with any of the elements in the GUI (clicking on a button, choosing a menu command, and so on), then only the "not yet implemented" message is displayed. This section shows you how to remedy this situation, by adding callback @@ -54,7 +53,9 @@ just using gadgets, then you only ever need to use callbacks. .. index:: single: task list manager; underlying data structures for tasks - + +.. _defining-the-underlying-data-structures-for-tasks: + Defining the underlying data structures for tasks ================================================= @@ -150,8 +151,8 @@ ensure that information about tasks is passed to the ``task-list`` pane correctly. Make these changes to the existing definition in the file ``frame.dylan``. -In `Gluing the final design together `_, the -definition of ``task-list`` was given as: +In :ref:`menus--gluing-it-together`, the definition of ``task-list`` was +given as: .. code-block:: dylan @@ -371,7 +372,9 @@ developing application, or in completely different applications. single: file handling in DUIM applications single: handling files in the task list manager single: task list manager; handling files - + +.. _handling-files-in-the-task-list-manager: + Handling files in the task list manager --------------------------------------- @@ -383,7 +386,7 @@ essential in even the most trivial application. .. index:: single: DUIM applications; file handling in - + There are three methods and two functions necessary for handling files. The methods handle GUI-specific operations involved in loading and saving files. The functions deal with the basic task of saving data @@ -825,7 +828,7 @@ itself. Note that the ``task-list-modified?`` slot of the ```` is set to ``#f``, reflecting the fact that the task list is loaded, but unchanged. This does not have to be done explicitly by ``load-task-list``, since ``#f`` is the default value of this slot, as you can see from its -definition in `Defining the underlying data structures for tasks`_. +definition in :ref:`defining-the-underlying-data-structures-for-tasks`. The file is opened for reading using the ``with-open-file`` macro. It is then read a line at a time, setting the local variables ``name`` and @@ -998,8 +1001,7 @@ As with other DUIM methods you have seen, ``frame`` and ``task-list`` are specified using known slot values about the gadget supplied to ``frame-add-task``, and the frame that contains the gadget. The ``name`` and ``priority`` values are specified by calling the ``prompt-for-task`` -method defined in `Creating a dialog for adding new -items `_. This method displays a dialog into which +method defined in :ref:`improve--creating-a-dialog-for-new-items`. This method displays a dialog into which the user types the text for the new task and chooses the priority, both of which values are returned from ``prompt-for-task``. @@ -1192,7 +1194,7 @@ section, together with a brief description of each one: Two methods are defined that deal with updating the GUI whenever a change is made to the task selection state. This method is described - in `Enabling and disabling buttons in the interface`_. + in :ref:`enable-disable-buttons`. ``refresh-task-frame`` @@ -1296,6 +1298,8 @@ in `DUIM support for adding and removing tasks`_. Add the code for these methods to ``frame.dylan``. +.. _enable-disable-buttons: + Enabling and disabling buttons in the interface ----------------------------------------------- @@ -1317,8 +1321,8 @@ method requires a slightly different definition, and the second method is not required at all. The ``note-task-selection-change`` method defined on ```` -is called by ``refresh-task-frame``, described on `Refreshing the -list of tasks `_. The +is called by ``refresh-task-frame``, described in `Refreshing the +list of tasks <#refreshing-the-list-of-tasks>`_. The refresh-task-frame method is called whenever the list of tasks needs to be refreshed for whatever reason. This happens most commonly after adding or removing a task from the list, or loading in a new task list diff --git a/documentation/source/building-with-duim/commands.rst b/documentation/source/building-with-duim/commands.rst index a1378e359a..4edf39ff94 100644 --- a/documentation/source/building-with-duim/commands.rst +++ b/documentation/source/building-with-duim/commands.rst @@ -242,7 +242,7 @@ Changes to button definitions The definition of each button in the definition of ```` needs to be modified compared to their definition in the Task List 1 project, -as described in `Gluing the new design together `_. +as described in :ref:`improve--gluing-it-together`. Broadly speaking, you need to update the ``command:`` keyword/argument pair for each button gadget, and you need to redefine the activate @@ -395,9 +395,7 @@ instance of ````. This change results in these new definitions: command-enabled?(frame-remove-task, frame) := task ~= #f; end method note-task-selection-change; -For details about ``note-task-selection-change``, see `Enabling and -disabling buttons in the interface `_. See `A -task list manager using command tables `_ for the -complete source code for the Task List 2 project. - - +For details about ``note-task-selection-change``, see +:ref:`enable-disable-buttons`. See +:ref:`task-list-manager-using-command-tables` for the complete source code for +the Task List 2 project. diff --git a/documentation/source/building-with-duim/design.rst b/documentation/source/building-with-duim/design.rst index 1b56b35289..9b1f857c00 100644 --- a/documentation/source/building-with-duim/design.rst +++ b/documentation/source/building-with-duim/design.rst @@ -220,7 +220,9 @@ box at the appropriate position in the call to ``vertically``. single: examples; using contain to run single: running examples interactively using contain single: contain to run examples interactively - + +.. _using-contain-to-run-examples-interactively: + Using contain to run examples interactively ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/documentation/source/building-with-duim/improve.rst b/documentation/source/building-with-duim/improve.rst index b43bfda0b1..723a76a569 100644 --- a/documentation/source/building-with-duim/improve.rst +++ b/documentation/source/building-with-duim/improve.rst @@ -3,7 +3,7 @@ Improving The Design ******************** The simple layout hierarchy described in `Creating the basic sheet -hierarchy `_ has a +hierarchy `_ has a number of problems associated with it, all of which revolve around the fact that the task list manager does not yet look very much like a standard Windows application. Although it is a simple design that does @@ -76,7 +76,9 @@ Make sure that this file is the last one listed in the project window. .. index:: single: applications; starting single: starting an application - + +.. _starting-the-application: + Starting the application ------------------------ @@ -173,7 +175,9 @@ defined, to make the task list manager do something more substantial. .. index:: single: defining; frame classes single: frame classes; defining - + +.. _defining-a-new-frame-class: + Defining a new frame class -------------------------- @@ -253,7 +257,7 @@ radio box, and the list box from the initial design: Note that the definition of each element is identical to the definitions included in the original layout described in `Creating the basic sheet hierarchy -`_ (except that +`_ (except that activate callbacks have been added to the code). Adding ``(frame)`` immediately after the name of each pane lets you refer to the frame itself within the frame definition using a local variable. This means @@ -266,7 +270,7 @@ the frame itself. In addition, you need to define the layout in which to place these panes. This is itself just another pane, and its definition is again identical to the original layout described in `Creating the basic -sheet hierarchy `_, +sheet hierarchy `_, with one exception; rather than defining each element explicitly, you just include a reference to the relevant pane that you have already defined using normal slot syntax, thus: @@ -379,8 +383,8 @@ robust, making it easier to modify and, eventually, maintain. If you want to try running your code, remember that you need to define some additional methods to create a frame instance and exit it cleanly. -Methods for doing this were provided in `Starting the -application`_. If you define these methods now, you +Methods for doing this were provided in :ref:`starting-the-application`. +If you define these methods now, you can create running versions of each successive generation of the application as it is developed. @@ -520,6 +524,8 @@ design. .. index:: single: task list manager; intermediate design +.. _improve--gluing-it-together: + Gluing the new design together ------------------------------ @@ -611,7 +617,7 @@ has reduced to a single column layout whose children are ``task-list`` and The definition for the new design of the frame class now looks as follows (button definitions vary slightly for the Task List 2 project, see `A task list manager using command tables -`_): +`_): .. code-block:: dylan @@ -671,12 +677,14 @@ see `A task list manager using command tables Note that this definition does not incorporate the original ``task-text`` pane defined in `Defining a new frame class`_. In fact, this part of the original interface is handled differently in the final design, and is -re-implemented in `Creating a dialog for adding new items`_. +re-implemented in :ref:`improve--creating-a-dialog-for-new-items`. .. index:: single: creating; basic sheet hierarchy single: dialogs; for requesting information, creating - + +.. _improve--creating-a-dialog-for-new-items: + Creating a dialog for adding new items -------------------------------------- @@ -716,14 +724,10 @@ new task. Add this method to ``frame.dylan``. .. note:: The definition of the ``prompt-for-task`` method uses the - ```` type. Note that this type is defined in `Defining - the underlying data structures for tasks - `_. Until - the relevant code in `Defining the underlying data structures for - tasks - `_ - is added to your project, any attempt to build it will generate a - serious warning. + ```` type. Note that this type is defined in + :ref:`defining-the-underlying-data-structures-for-tasks`. Until the relevant + code in :ref:`defining-the-underlying-data-structures-for-tasks` is added + to your project, any attempt to build it will generate a serious warning. .. code-block:: dylan diff --git a/documentation/source/building-with-duim/menus.rst b/documentation/source/building-with-duim/menus.rst index 2bdc8d512c..6d42326f84 100644 --- a/documentation/source/building-with-duim/menus.rst +++ b/documentation/source/building-with-duim/menus.rst @@ -262,7 +262,9 @@ about keyboard accelerators: .. index:: single: task list manager; final design - + +.. _menus--gluing-it-together: + Gluing the final design together -------------------------------- @@ -278,12 +280,10 @@ the class ```` as a value, the default value being an empty ````. Although it has not been referred to so far, this class will be used as the basic data structure in which task lists are stored, and a more complete description of these data structures is -given in `Defining the underlying data structures for tasks -`_. It +given in :ref:`defining-the-underlying-data-structures-for-tasks`. It transpires that defining the ``frame-task-list`` slot is essential for -some of the file handling routines that are described in `Handling -files in the task list manager -`_. +some of the file handling routines that are described in +:ref:`handling-files-in-the-task-list-manager`. .. code-block:: dylan diff --git a/documentation/source/building-with-duim/source.rst b/documentation/source/building-with-duim/source.rst index e5194a82f2..b9b1b25257 100644 --- a/documentation/source/building-with-duim/source.rst +++ b/documentation/source/building-with-duim/source.rst @@ -9,9 +9,9 @@ Source Code For The Task List Manager For completeness, here is the full source code for both versions of the task list manager. If you have followed the example given in :doc:`design` through :doc:`commands` from the beginning, then your code should be the -same as the code given in `A task list manager using menu gadgets`_. The +same as the code given in :ref:`task-list-manager-using-menu-gadgets`. The source code for the second version of the task list manager, using command -tables, is given in `A task list manager using command tables`_. +tables, is given in :ref:`task-list-manager-using-command-tables`. .. note: Please note that both projects have the same name within the source code— *task-list* —and you should not load them both into the environment @@ -21,7 +21,9 @@ tables, is given in `A task list manager using command tables`_. single: menu gadgets; task list manager example single: task list manager; menu gadgets implementation single: using; menu gadgets - + +.. _task-list-manager-using-menu-gadgets: + A task list manager using menu gadgets -------------------------------------- @@ -478,7 +480,9 @@ Contents of the file *task-list.dylan* : .. index:: single: task list manager; command table implementation single: using; command tables - + +.. _task-list-manager-using-command-tables: + A task list manager using command tables ---------------------------------------- @@ -491,13 +495,12 @@ List 2 in the Documentation category of the Open Example Project dialog. .. index:: command tables; task list manager example - + The command tables used in this implementation are described in :doc:`commands`. You should refer to :doc:`improve` and :doc:`callbacks`, for a full description of the rest of the code shown here. Note that, apart from code specific to command tables and callbacks, the code listed -in this section is a repeat of code listed in `A task list manager using -menu gadgets`_. +in this section is a repeat of code listed in :ref:`task-list-manager-using-menu-gadgets`. Contents of the file *frame.dylan* : ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/documentation/source/building-with-duim/tour.rst b/documentation/source/building-with-duim/tour.rst index 46b10adfae..5a959eed79 100644 --- a/documentation/source/building-with-duim/tour.rst +++ b/documentation/source/building-with-duim/tour.rst @@ -62,18 +62,16 @@ these elements. your own classes of frame. You can use the Dylan Playground to run the examples in this chapter. -*Reminder:* to interactively run the segments of example code -presented in this chapter, you must pass them to ``contain`` (see -`Using contain to run examples interactively -`_ for -details). +*Reminder:* to interactively run the segments of example code presented in this +chapter, you must pass them to ``contain`` (see +:ref:`using-contain-to-run-examples-interactively` for details). .. index:: single: gadgets; tour single: introduction to; gadgets single: overview of; gadgets single: tour of; gadgets - + A tour of gadgets ----------------- @@ -86,7 +84,7 @@ common interface elements are defined as subclasses of the base class single: gadgets; general properties single: general properties of gadgets single: properties; gadgets, general - + General properties of gadgets ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -1630,8 +1628,7 @@ both the width and height of a frame. Defining new classes of frame ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -As described in `Defining a new frame class -`_, the ``define frame`` +As described in :ref:`defining-a-new-frame-class`, the ``define frame`` macro is used to create new classes of frame. The bulk of the definition of any new frame is split into several parts: @@ -1854,7 +1851,7 @@ non-standard title to the dialog. Further examples of this function can be found in `Handling files in the task list manager -`_. +`_. The convenience functions ``choose-color`` and ``choose-text-style`` generate the common dialogs for choosing a color and a font diff --git a/documentation/source/community/gsoc/2012/cocoa.rst b/documentation/source/community/gsoc/2012/cocoa.rst index cf7e8083f5..0198c247b1 100644 --- a/documentation/source/community/gsoc/2012/cocoa.rst +++ b/documentation/source/community/gsoc/2012/cocoa.rst @@ -17,5 +17,5 @@ Interesting prior art: - `jscocoa BridgeSupport usage `_ - `LuaCocoa `_ - `Clozure CL Objective C bridge `_ -- `LispWorks Objective C interface `_ +- `LispWorks Objective C interface `_ - `A list of a lot of Cocoa Bridges `_ diff --git a/documentation/source/community/gsoc/2012/dispatch.rst b/documentation/source/community/gsoc/2012/dispatch.rst index 140c909fe4..bee1e5b04c 100644 --- a/documentation/source/community/gsoc/2012/dispatch.rst +++ b/documentation/source/community/gsoc/2012/dispatch.rst @@ -12,5 +12,5 @@ For this project some algorithmic knowledge is needed. The code will be mainly i Useful links: -- `Eric Kidds technical report on compression of generic function tables `_ +- `Eric Kidds technical report on compression of generic function tables `_ - `Yoav Zibin thesis about efficient runtime algorithms `_ diff --git a/documentation/source/community/gsoc/2012/project_manager.rst b/documentation/source/community/gsoc/2012/project_manager.rst index ec56f52bba..83bd8addf5 100644 --- a/documentation/source/community/gsoc/2012/project_manager.rst +++ b/documentation/source/community/gsoc/2012/project_manager.rst @@ -106,12 +106,12 @@ what many other programming language communities provide: * Clojure: `Leiningen `_ * Common Lisp: `QuickLisp `_ -* Emacs Lisp: `Marmalade `_ / `ELPA `_ +* Emacs Lisp: `Marmalade `_ / `ELPA `_ * Erlang: `EPM `_ * haXe: `haxelib `_ * Lua: `LuaRocks `_ * NodeJS: `NPM `_ -* Haskell: `Hackage `_ +* Haskell: `Hackage `_ * Ocaml: `GODI `_ * PHP: `PEAR `_ * Perl: CPAN diff --git a/documentation/source/community/index.rst b/documentation/source/community/index.rst index 3a4e53a84b..4d702849ea 100644 --- a/documentation/source/community/index.rst +++ b/documentation/source/community/index.rst @@ -37,7 +37,7 @@ Mailing List back-and-forth of chat, this is the preferred place for it. `comp.lang.dylan - `_ also exists, + `_ also exists, but dylan-lang@ is the preferred forum. Dylan on Other Sites @@ -47,5 +47,5 @@ Dylan on Other Sites Pick a Project to Work On If you're looking for ideas, maybe you'll find something in the - old `Google Summer of Code suggestions `_ or on the + old :doc:`Google Summer of Code ` suggestions or on the `opendylan GitHub wiki `_. diff --git a/documentation/source/corba-guide/projects.rst b/documentation/source/corba-guide/projects.rst index 7e65e1a2bd..b8e3516999 100644 --- a/documentation/source/corba-guide/projects.rst +++ b/documentation/source/corba-guide/projects.rst @@ -72,8 +72,8 @@ To create a CORBA project with the New Project wizard: #. Click :guilabel:`Next`. The next page is the standard wizard page for naming a project and - specifying its location. (See `Getting Started with Open Dylan > Projects - `_ for details.) + specifying its location. (See :doc:`Getting Started with Open Dylan > Projects + ` for details.) The project name you specify here is not used literally when the wizard creates the project or projects. Instead, if you chose to create a client diff --git a/documentation/source/documentation/cheatsheets/collections.rst b/documentation/source/documentation/cheatsheets/collections.rst index 4eb519d140..53edb48f82 100644 --- a/documentation/source/documentation/cheatsheets/collections.rst +++ b/documentation/source/documentation/cheatsheets/collections.rst @@ -22,24 +22,24 @@ Common Collection Types +--------------------------+------------------------------------+----------------------------------------+ | :drm:`` | ``dylan:dylan`` | A double-ended queue. | +--------------------------+------------------------------------+----------------------------------------+ -| `\`_ | ``collections:set`` | A set is for efficiently tracking | +| :class:`` | ``collections:set`` | A set is for efficiently tracking | | | | membership. | +--------------------------+------------------------------------+----------------------------------------+ -| `\`_ | ``collections:bit-set`` | A set with bits for members. | +| :class:`` | ``collections:bit-set`` | A set with bits for members. | +--------------------------+------------------------------------+----------------------------------------+ -| `\`_ | ``collections:bit-vector`` | A vector optimized for storing bit | +| :class:`` | ``collections:bit-vector`` | A vector optimized for storing bit | | | | values. | +--------------------------+------------------------------------+----------------------------------------+ -| `\`_ | ``collections:byte-vector`` | A vector of bytes. | +| :class:`` | ``collections:byte-vector`` | A vector of bytes. | +--------------------------+------------------------------------+----------------------------------------+ | :drm:`` | ``dylan:dylan`` | A mapping between keys and values. | +--------------------------+------------------------------------+----------------------------------------+ -| `\`_ | ``collections:table-extensions`` | A ``
`` with strings for keys. | +| :class:`` | ``collections:table-extensions`` | A :drm:`
` with strings for keys.| +--------------------------+------------------------------------+----------------------------------------+ .. note:: - Because of the default comparison function for ``
``, it is + Because of the default comparison function for :drm:`
`, it is important to use ```` when the keys will be strings. Mutable vs. Immutable @@ -159,9 +159,3 @@ Common Operations | :drm:`
` | :drm:`remove-key!` | Modifies an explicit key collection so it no longer | | | | has a particular key. | +---------------------+------------------------------+------------------------------------------------------+ - -.. _: library-reference/collections/set.html -.. _: library-reference/collections/bit-set.html -.. _: library-reference/collections/bit-vector.html -.. _: library-reference/common-dylan/byte-vector.html -.. _: library-reference/collections/table-extensions.html#collections:table-extensions:[string-table] diff --git a/documentation/source/documentation/index.rst b/documentation/source/documentation/index.rst index 2465e69078..1095ea7d88 100644 --- a/documentation/source/documentation/index.rst +++ b/documentation/source/documentation/index.rst @@ -11,10 +11,10 @@ Learn Dylan :doc:`../intro-dylan/index` This tutorial is written primarily for those with solid programming experience in C++ or another object-oriented, static language. It - provides a gentler introduction to Dylan than does the `Dylan Reference - Manual`_ (DRM). + provides a gentler introduction to Dylan than does the :drm:`Dylan Reference + Manual ` (DRM). -`Dylan Programming Guide`_ [`pdf <https://opendylan.org/books/dpg/DylanProgramming.pdf>`__] [`epub <https://opendylan.org/books/dpg/DylanProgramming.epub>`__] +`Dylan Programming Guide <https://opendylan.org/package/dylan-programming-book/>`_ A book length Dylan tutorial. :doc:`../getting-started-cli/index` @@ -32,7 +32,7 @@ Learn Dylan References ========== -`Dylan Reference Manual`_ (`Errata`_) +:drm:`Dylan Reference Manual <Title>` (:drm:`Errata`) The official definition of the Dylan language and standard library. :doc:`../library-reference/index` @@ -58,12 +58,12 @@ Articles This essay explores Dylan from the perspective of a programmer used to traditional procedural languages, such as Pascal or C. -:doc:`../package/http/server/quickstart/index` +`Dylan Package Documentation <https/package/http/server/quickstart/>`_ A quick introduction to web development in Dylan. :doc:`../news/2011/12/12/dswank` by Hannes Mehnert. An exciting look at using DIME and emacs for Dylan development. - DIME is for Dylan what `SLIME <https://common-lisp.net/project/slime/>`_ + DIME is for Dylan what `SLIME <https://slime.common-lisp.dev/>`_ is for Common Lisp. :doc:`../articles/beyond-java` @@ -75,8 +75,8 @@ Articles Publications ============ -See the `publications page <publications.html>`_ for a full list. Below are a -few highlighted publications. +See the :doc:`publications page <publications>` for a full +list. Below are a few highlighted publications. **LLVM Code Generation for Open Dylan** (by Peter Housel at ELS 2020 `pdf <https://zenodo.org/record/3742567/files/els2020-opendylan.pdf?download=1>`__ `bib <../_static/documentation/housel_peter_s_2020_3742567.bib>`__ `slides <https://european-lisp-symposium.org/static/2020/housel-slides.pdf>`__ `video <https://www.youtube.com/watch?v=6dcrXBzw4H4>`__) The Open Dylan compiler, DFMC, was originally designed in the 1990s @@ -94,7 +94,7 @@ few highlighted publications. implementation of the LLVM back-end and its associated run-time support. - https://doi.org/10.5281/zenodo.3742567 + https://zenodo.org/records/3742567 **Extending Dylan's type system for better type inference and error detection** (by Hannes Mehnert at ILC 2010 `pdf <http://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.627.5175&rep=rep1&type=pdf>`__ `bib <../_static/documentation/mehnert2010.bib>`__) Whereas dynamic typing enables rapid prototyping and easy @@ -114,7 +114,7 @@ few highlighted publications. generates faster code with fewer errors. Some previously undiscovered errors in the Dylan library were revealed. - https://dl.acm.org/doi/10.1145/1869643.1869645 + https://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.627.5175&rep=rep1&type=pdf **D-Expressions: Lisp Power, Dylan Style** [`pdf <http://people.csail.mit.edu/jrb/Projects/dexprs.pdf>`__] [`bib <../_static/documentation/bachrach1999.bib>`__] This paper aims to demonstrate that it is possible for a language @@ -150,21 +150,17 @@ For Open Dylan Developers .. TODO: some of the below links should be relative so they work in a test installation of the website. -.. _Dylan Programming Guide: https://opendylan.org/books/dpg/ -.. _Dylan Reference Manual: https://opendylan.org/books/drm/ -.. _Errata: https://opendylan.org/books/drm/Errata - .. toctree:: :hidden: - News <../news/index> + News </news/index> Cheat Sheets <cheatsheets/index> Publications <publications> - Intro to Dylan <../intro-dylan/index> - CORBA Guide <../corba-guide/index> - DUIM Guide <../building-with-duim/index> - DUIM Reference <../duim-reference/index> - Getting Started / IDE <../getting-started-ide/index> - Release Notes <../release-notes/index> - Sphinx Extensions <../../sphinx-extensions/documentation/source/index> - Style Guide <../style-guide/index> + Intro to Dylan </intro-dylan/index> + CORBA Guide </corba-guide/index> + DUIM Guide </building-with-duim/index> + DUIM Reference </duim-reference/index> + Getting Started / IDE </getting-started-ide/index> + Release Notes </release-notes/index> + Style Guide </style-guide/index> + Dylan History </history/index> diff --git a/documentation/source/documentation/publications.rst b/documentation/source/documentation/publications.rst index a3c9724f53..74a5084cd4 100644 --- a/documentation/source/documentation/publications.rst +++ b/documentation/source/documentation/publications.rst @@ -38,7 +38,7 @@ Publications about Dylan generates faster code with fewer errors. Some previously undiscovered errors in the Dylan library were revealed. - https://doi.org/10.1145/1869643.1869645 + https://dl.acm.org/doi/10.1145/1869643.1869645 **Automatically generated type-safe GTK+ binding for Dylan** (by Hannes Mehnert at ILC 2009 `pdf <https://www.researchgate.net/profile/Hannes_Mehnert/publication/255630976_Automatically_generated_type-safe_GTK_binding_for_Dylan/links/558fd23308ae15962d8b5e66/Automatically-generated-type-safe-GTK-binding-for-Dylan.pdf>`__ `bib <../_static/documentation/mehnert2009.bib>`__) We present an automated way to get language bindings for GTK+ for @@ -59,7 +59,7 @@ Publications about Dylan the parse tree, and we will show the strengths and limits of this approach for the given problem. - https://doi.org/10.1145/1622123.1622148 + https://dl.acm.org/doi/10.1145/1622123.1622148 **Secure Networking** (by Andreas Bogk and Hannes Mehnert at 23rd Chaos Communication Congress `pdf <https://www.researchgate.net/profile/Hannes_Mehnert/publication/228910362_Secure_networking/links/558fefe308aed6ec4bf64b82/Secure-networking.pdf>`__) We noticed a lack of a decent secure framework for handling @@ -121,7 +121,7 @@ Publications about Dylan Component Object Model (COM), and how they attempt to reduce the complexity of writing and using COM objects. - https://doi.org/10.1145/274946.274957 + https://dl.acm.org/doi/10.1145/274946.274957 **A Monotonic Superclass Linearization for Dylan** (by Kim Barrett and Bob Cassels and Paul Haahr and David A. Moon and Keith Playford and P. Tucker Withington at OOPSLA 1996 `PDF <../_static/c3-linearization.pdf>`__ `bib <../_static/documentation/barrett1996.bib>`__) Object-oriented languages with multiple inheritance and automatic @@ -140,7 +140,7 @@ Publications about Dylan heterarchies from several large programs, analyzing where commonly used linearizations differ. - https://doi.org/10.1145/236337.236343 + https://dl.acm.org/doi/10.1145/236337.236343 **Discovering the way programmers think about new programming environments** (by Joseph Dumas and Paige Parsons - Communications of the ACM June 1995 `bib <../_static/documentation/dumas1995.bib>`__) An interesting usability study of a prototype development @@ -152,7 +152,7 @@ Publications about Dylan how effectively the prototype conveys these innovations to Dylan developers is also given, followed by some proposed improvements. - https://doi.org/10.1145/203241.203253 + https://dl.acm.org/doi/10.1145/203241.203253 `Bibliography in bibtex format <../_static/documentation/publications.bib>`_ diff --git a/documentation/source/duim-reference/conventions.rst b/documentation/source/duim-reference/conventions.rst index 5623bb88c0..f543a217ef 100644 --- a/documentation/source/duim-reference/conventions.rst +++ b/documentation/source/duim-reference/conventions.rst @@ -10,8 +10,7 @@ Audience, goals, and purpose This manual is intended for programmers using DUIM, and forms a complete reference for the Application Programmer's Interface (API) for DUIM. You -should also see `Building Applications using DUIM -<http://opendylan.org/documentation/building-with-duim/>`_ for a description of +should also see :doc:`/building-with-duim/index` for a description of how to start building applications using DUIM. At some points, the API also includes lower-level layers, which DUIM programmers are free to specialize. diff --git a/documentation/source/duim-reference/frames.rst b/documentation/source/duim-reference/frames.rst index ec7f65c617..ac81c434bf 100644 --- a/documentation/source/duim-reference/frames.rst +++ b/documentation/source/duim-reference/frames.rst @@ -48,20 +48,10 @@ with a number of classes related to events that occur in frames. - :drm:`<object>` - :class:`<gadget>` - - :class:`<page>` - - - See `Subclasses of \<page\>`_ - - - :class:`<frame>` - - - See `Subclasses of \<frame\>`_ - + - :class:`<page>` - See :ref:`gadgets-subclasses-of-page` + - :class:`<frame>` - See `Subclasses of \<frame\>`_ - :class:`<event>` - - - :class:`<frame-event>` - - - See `Subclasses of \<frame-event\>`_ - + - :class:`<frame-event>` - See `Subclasses of \<frame-event\>`_ - :class:`<simple-command>` - :class:`<simple-undoable-command>` - :class:`<command-table>` @@ -174,14 +164,15 @@ using the application. from the screen without actually destroying it (for example, a frame may be iconized). +.. _frames-subclasses-of-page: + Subclasses of <page> ^^^^^^^^^^^^^^^^^^^^ Although the :class:`<page>` class is itself a subclass of :class:`<gadget>`, and is exposed by the DUIM-Gadgets library, two of its subclasses are exposed by the DUIM-Frames library: :class:`<wizard-page>` and :class:`<property-page>`. See -`Subclasses of <page> <gadgets.htm#31084>`_ for an introduction to -these classes. +:ref:`gadgets-subclasses-of-page` for an introduction to these classes. DUIM-Commands Library ===================== @@ -4310,7 +4301,7 @@ are exported from the *duim-frames* module. #"mapped", #"iconified")``. Default value: ``#"detached"``. :param #key geometry: An instance of type :drm:`<vector>`. Default value: ``vector(#f, #f, #f, #f)``. :param #key resizable?: An instance of type :drm:`<boolean>`. Default value: ``#t``. - :param #key properties: An instance of type :drm:`<stretchy-object-vector>`. Default value: ``make(<stretchy-vector>)``. + :param #key properties: An instance of type :class:`<stretchy-object-vector>`. Default value: ``make(<stretchy-vector>)``. :param #key thread: An instance of type ``false-or(<thread>)``. Default value: ``#f``. :param #key event-queue: An instance of type ``false-or(<event-queue>)``. Default value: ``#f``. :param #key foreground: An instance of type ``false-or(<ink>)``. Default value: ``#f``. diff --git a/documentation/source/duim-reference/gadgets.rst b/documentation/source/duim-reference/gadgets.rst index 0db071d656..10f7b7be68 100644 --- a/documentation/source/duim-reference/gadgets.rst +++ b/documentation/source/duim-reference/gadgets.rst @@ -226,7 +226,7 @@ particular parts of a user interface to be created: The :class:`<gadget>` class provides a number of subclasses that allow general spatial and grouping capability, in addition to the layout -functionality described in `DUIM-Layouts Library <layouts.htm#21962>`_. +functionality described in :doc:`DUIM-Layouts Library <layouts>`. These are as follows: :class:`<label>` @@ -383,6 +383,8 @@ See `Subclasses of \<button\>`_ See `Subclasses of \<collection-gadget\>`_ +.. _gadgets-subclasses-of-page: + Subclasses of <page> ^^^^^^^^^^^^^^^^^^^^ @@ -3764,7 +3766,7 @@ are exported from the *duim-gadgets* module. :param framem: An instance of type :class:`<frame-manager>`. :param items: An instance of type :drm:`<sequence>`. :param #key owner: An instance of type :class:`<sheet>`. - :param #key title: An instance of type :drm:`<string>``. + :param #key title: An instance of type :drm:`<string>`. :param #key label-key: An instance of :drm:`<function>`. Default value: :drm:`identity`. :param #key value-key: An instance of :drm:`<function>`. Default value: :drm:`identity`. :param #key foreground: An instance of type ``false-or(<ink>)``. Default value: ``#f``. diff --git a/documentation/source/getting-started-cli/cross-compilation.rst b/documentation/source/getting-started-cli/cross-compilation.rst index f0a89a9bc4..27b4072924 100644 --- a/documentation/source/getting-started-cli/cross-compilation.rst +++ b/documentation/source/getting-started-cli/cross-compilation.rst @@ -1,7 +1,5 @@ Cross Compilation ================= -For now, see the `porting section`_ of the `Hacker's Guide`_. - -.. _porting section: https://opendylan.org/documentation/hacker-guide/topics/porting.html -.. _Hacker's Guide: https://opendylan.org/documentation/hacker-guide/ +For now, see the :doc:`porting section </hacker-guide/topics/porting>` of the +:doc:`/hacker-guide/index`. diff --git a/documentation/source/getting-started-cli/debugging-with-gdb-lldb.rst b/documentation/source/getting-started-cli/debugging-with-gdb-lldb.rst index 9a20016ad1..53760b2827 100644 --- a/documentation/source/getting-started-cli/debugging-with-gdb-lldb.rst +++ b/documentation/source/getting-started-cli/debugging-with-gdb-lldb.rst @@ -66,7 +66,8 @@ Following these rules, method ``format-err`` in the ``format-out`` module of the ``io`` library becomes ``Kformat_errYformat_outVioMM0I``. -For full details, see `the Hacker's guide <https://opendylan.org/documentation/hacker-guide/runtime/mangling.html?highlight=mangling>`_. +For full details, see :doc:`the Hacker's guide +</hacker-guide/runtime/mangling>`. Understanding stack traces -------------------------- diff --git a/documentation/source/getting-started-cli/dylan-mode-for-emacs.rst b/documentation/source/getting-started-cli/dylan-mode-for-emacs.rst index ec28665933..f39d5eb57c 100644 --- a/documentation/source/getting-started-cli/dylan-mode-for-emacs.rst +++ b/documentation/source/getting-started-cli/dylan-mode-for-emacs.rst @@ -24,8 +24,7 @@ dylan-emacs-support repository. '((opendylan ("/opt/opendylan/bin/dswank") :env ("OPEN_DYLAN_USER_REGISTRIES=/tmp/dime-test/registry")))) -Setting `OPEN_DYLAN_USER_REGISTRIES -<source-registries.html#open-dylan-user-registries>`_ is important because +Setting :ref:`OPEN_DYLAN_USER_REGISTRIES <open-dylan-user-registries>` is important because that's how DIME finds your projects. Above we set it to the dime-test registry that is created in the example below. diff --git a/documentation/source/getting-started-cli/editor-support.rst b/documentation/source/getting-started-cli/editor-support.rst index 4b5e3091f6..6a7eaea0fd 100644 --- a/documentation/source/getting-started-cli/editor-support.rst +++ b/documentation/source/getting-started-cli/editor-support.rst @@ -39,6 +39,6 @@ However, enhanced support is available in `dylan-vim`_. .. _language-dylan: https://atom.io/packages/language-dylan -.. _DeftIDEA: http://plugins.jetbrains.com/plugin/7325-deftidea +.. _DeftIDEA: https://plugins.jetbrains.com/plugin/7325-deftidea .. _dylan.tmbundle: https://github.com/textmate/dylan.tmbundle .. _dylan-vim: https://github.com/dylan-lang/dylan-vim diff --git a/documentation/source/getting-started-cli/index.rst b/documentation/source/getting-started-cli/index.rst index 142885ce1f..ac8bde9664 100644 --- a/documentation/source/getting-started-cli/index.rst +++ b/documentation/source/getting-started-cli/index.rst @@ -5,9 +5,8 @@ Getting Started with the Open Dylan Command Line Tools This guide explains how to use the Open Dylan command-line tools to develop and deliver Dylan applications. -For help getting started with the IDE (Windows only), see `Getting Started with -the Open Dylan IDE -<https://opendylan.org/documentation/getting-started-ide/>`_. +For help getting started with the IDE (Windows only), see :doc:`Getting Started +with the Open Dylan IDE </getting-started-ide/index>`. The compiler executable is called ``dylan-compiler``. There is a helper application called :program:`dylan`, which can be used to generate some diff --git a/documentation/source/getting-started-cli/source-registries.rst b/documentation/source/getting-started-cli/source-registries.rst index 6bd4ae0080..29633d3d28 100644 --- a/documentation/source/getting-started-cli/source-registries.rst +++ b/documentation/source/getting-started-cli/source-registries.rst @@ -54,6 +54,7 @@ When you invoke :program:`dylan-compiler` in the directory containing a "registry" directory it automatically uses that registry, in addition to (and taking precedence over) the registry in the Open Dylan installation directory. +.. _open-dylan-user-registries: OPEN_DYLAN_USER_REGISTRIES -------------------------- diff --git a/documentation/source/getting-started-ide/preface.rst b/documentation/source/getting-started-ide/preface.rst index d8944c8f0c..0cdc49f8a1 100644 --- a/documentation/source/getting-started-ide/preface.rst +++ b/documentation/source/getting-started-ide/preface.rst @@ -6,8 +6,8 @@ This guide explains how to use the Open Dylan IDE (Windows only) to develop and deliver Dylan applications. For help getting started with the command-line -tools, see the `Getting Started with the Open Dylan Command Line Tools -<https://opendylan.org/documentation/getting-started-cli>`_ guide. +tools, see the :doc:`Getting Started with the Open Dylan Command Line Tools +</getting-started-cli/index>` guide. .. index:: single: Dylan Reference Manual, the diff --git a/documentation/source/hacker-guide/build-system.rst b/documentation/source/hacker-guide/build-system.rst index 337098cb93..202ac6a8b6 100644 --- a/documentation/source/hacker-guide/build-system.rst +++ b/documentation/source/hacker-guide/build-system.rst @@ -319,8 +319,8 @@ Editing Jam Files There is an `Emacs major mode`_ for editing Jam files. -.. _Jam: http://www.perforce.com/resources/documentation/jam -.. _Perforce Software: http://www.perforce.com/ +.. _Jam: https://www.perforce.com/resources/documentation/jam +.. _Perforce Software: https://www.perforce.com/ .. _Jam manual page: https://swarm.workshop.perforce.com/view/guest/perforce_software/jam/src/Jam.html .. _Jambase: https://swarm.workshop.perforce.com/files/guest/perforce_software/jam/src/Jambase .. _Jambase reference: https://swarm.workshop.perforce.com/view/guest/perforce_software/jam/src/Jambase.html diff --git a/documentation/source/hacker-guide/documentation/doctower.rst b/documentation/source/hacker-guide/documentation/doctower.rst index 776dd053f6..f23ecf79e9 100644 --- a/documentation/source/hacker-guide/documentation/doctower.rst +++ b/documentation/source/hacker-guide/documentation/doctower.rst @@ -9,4 +9,4 @@ it will not integrate cleanly with Sphinx and our other documentation. We don't currently use this tool for any of the Open Dylan documentation. -.. _available on GitHub: http://github.com/dylan-lang/doctower +.. _available on GitHub: https://github.com/dylan-lang/doctower diff --git a/documentation/source/hacker-guide/documentation/example.rst b/documentation/source/hacker-guide/documentation/example.rst index 5d5f66e177..4b1cf833ec 100644 --- a/documentation/source/hacker-guide/documentation/example.rst +++ b/documentation/source/hacker-guide/documentation/example.rst @@ -13,7 +13,7 @@ A skip-list is a data type equivalent to a balanced (binary) tree. .. library:: skip-list The skip list library may be found in the `"skip-list" repository - <http://github.com/dylan-lang/skip-list>`_. + <https://github.com/dylan-lang/skip-list>`_. .. module:: skip-list diff --git a/documentation/source/hacker-guide/documentation/index.rst b/documentation/source/hacker-guide/documentation/index.rst index 890c245f8b..0396bf9f68 100644 --- a/documentation/source/hacker-guide/documentation/index.rst +++ b/documentation/source/hacker-guide/documentation/index.rst @@ -4,7 +4,7 @@ Writing Documentation We are working on a tool to automatically generate skeletal documentation from source code, but until then, we are documenting the Open Dylan libraries -manually using `Sphinx <http://sphinx-doc.org/>`_ to build the HTML pages. +manually using `Sphinx <https://sphinx-doc.org/>`_ to build the HTML pages. Sphinx uses reStructuredText markup with some extensions of its own, and we have created additional extensions to document Dylan language entities. diff --git a/documentation/source/hacker-guide/index.rst b/documentation/source/hacker-guide/index.rst index 3eb7a26336..21b21afc81 100644 --- a/documentation/source/hacker-guide/index.rst +++ b/documentation/source/hacker-guide/index.rst @@ -28,8 +28,8 @@ what others might find useful, please see our `list of projects in the Open Dylan wiki <https://github.com/dylan-lang/opendylan/wiki>`_ or check out the list of `bugs labeled Easy <https://github.com/dylan-lang/opendylan/labels/Easy>`_. If you have -something in mind that isn't there, feel free to `talk with us -<http://opendylan.org/community/>`_ or add it to the list. +something in mind that isn't there, feel free to :doc:`talk with us +</community/index>` or add it to the list. Making Changes ============== @@ -69,14 +69,13 @@ Guidelines * Update documentation as necessary. Also, if appropriate, update the release notes, samples and other supporting materials. * We suggest following `this note about git commit messages - <http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html>`_. -* Follow the `style guide - <http://opendylan.org/documentation/style-guide/index.html>`_ for - new code. When working in existing code, follow the existing style. + <https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html>`_. +* Follow the :doc:`style guide </style-guide/index>` for new code. When + working in existing code, follow the existing style. * Do not make a lot of style or whitespace fixes in the same commit as other changes. * Use 2 spaces for indentation, **never** tabs. If you use emacs, - `dylan-mode <https://github.com/dylan-lang/dylan-mode>`_ does a + `dylan-mode <https://github.com/dylan-lang/dylan-emacs-support>`_ does a decent job of indenting code. Licensing diff --git a/documentation/source/hacker-guide/runtime-manager/access-path.rst b/documentation/source/hacker-guide/runtime-manager/access-path.rst index e4279e740a..f7f8e25683 100644 --- a/documentation/source/hacker-guide/runtime-manager/access-path.rst +++ b/documentation/source/hacker-guide/runtime-manager/access-path.rst @@ -468,7 +468,7 @@ Remote Processes :signature: remote-process-actual-identifier (object) => (value) :parameter object: An instance of :class:`<remote-process>`. - :value value: An instance of :drm:`<abstract-integer>`. + :value value: An instance of :class:`<abstract-integer>`. Remote Threads -------------- @@ -482,7 +482,7 @@ Remote Threads :keyword name: An instance of :drm:`<string>`. :keyword required nub-descriptor: An instance of :const:`<nubthread>`. :keyword os-priority: An instance of :drm:`<integer>`. - :keyword required rnub-descriptor: An instance of :drm:`<abstract-integer>`. + :keyword required rnub-descriptor: An instance of :class:`<abstract-integer>`. :keyword state: An instance of :drm:`<string>`. The class that models a thread in an application process. Instances @@ -675,7 +675,7 @@ shared library, such as a DLL under Windows. :keyword core-name: An instance of :drm:`<string>`. :keyword locator: An instance of :drm:`<string>`. :keyword nub-descriptor: An instance of :const:`<nublibrary>`. - :keyword rnub-descriptor: An instance of :drm:`<abstract-integer>`. + :keyword rnub-descriptor: An instance of :class:`<abstract-integer>`. :keyword version-major: An instance of :drm:`<integer>`. :keyword version-minor: An instance of :drm:`<integer>`. @@ -812,7 +812,7 @@ Remote Object Files :signature: remote-object-file-library (object) => (value) :parameter object: An instance of :class:`<remote-object-file>`. - :value value: An instance of :drm:`<remote-library>`. + :value value: An instance of :class:`<remote-library>`. .. generic-function:: remote-object-file-language @@ -862,7 +862,7 @@ operate in terms of the virtual memory of the application. :signature: as-integer (x) => (i) :parameter x: An instance of :drm:`<object>`. - :value i: An instance of :drm:`<abstract-integer>`. + :value i: An instance of :class:`<abstract-integer>`. Converts the remote value to an <abstract-integer> (NB the concrete representation may be a big integer as defined in the @@ -888,7 +888,7 @@ operate in terms of the virtual memory of the application. :signature: as-remote-value (x) => (ptr) - :parameter x: An instance of :drm:`<abstract-integer>`. + :parameter x: An instance of :class:`<abstract-integer>`. :value ptr: An instance of :type:`<remote-value>`. Converts the given abstract integer to a :type:`<remote-value>`. @@ -897,7 +897,7 @@ operate in terms of the virtual memory of the application. :signature: as-remote-pointer (x) => (ptr) - :parameter x: An instance of :drm:`<abstract-integer>`. + :parameter x: An instance of :class:`<abstract-integer>`. :value ptr: An instance of :const:`<descriptor-pointer>`. .. generic-function:: indexed-remote-value diff --git a/documentation/source/hacker-guide/runtime/startup.rst b/documentation/source/hacker-guide/runtime/startup.rst index 3542219c12..fcb983f5a6 100644 --- a/documentation/source/hacker-guide/runtime/startup.rst +++ b/documentation/source/hacker-guide/runtime/startup.rst @@ -113,7 +113,7 @@ the library's glue function, named ``_Init_``\ *mangled-library-name*, into the ``_init_dylan_library`` variable and branches to ``_DylanDllEntry@12``. A `DllMain entry point -<https://msdn.microsoft.com/en-us/library/windows/desktop/ms682583%28v=vs.85%29.aspx>`_ +<https://learn.microsoft.com/en-us/windows/win32/dlls/dllmain>`_ receives three arguments: the module handle of the DLL, a reason code, and a flag that indicates whether the DLL was loaded statically or dynamically. The ``_DylanDllEntry@12`` routine, generated in ``sources/harp/x86-windows-rtg/ffi-barrier.dylan``, looks at the reason diff --git a/documentation/source/hacker-guide/topics/debugging.rst b/documentation/source/hacker-guide/topics/debugging.rst index 9d7ce0e8dc..e5725c0aa2 100644 --- a/documentation/source/hacker-guide/topics/debugging.rst +++ b/documentation/source/hacker-guide/topics/debugging.rst @@ -8,8 +8,8 @@ Debugging a Compiler Crash or Internal Error When the compiler generates an internal error or directly crashes, using gdb or lldb is a great way to find out more about what has gone wrong. -See `Debugging with GDB or LLDB`_ for general information on debugging -applications written with Open Dylan. +See :doc:`/getting-started-cli/debugging-with-gdb-lldb` for general information +on debugging applications written with Open Dylan. An internal error from the compiler will often look something like this:: @@ -34,4 +34,4 @@ invoke ``dylan-compiler``. This will generate DFM output files in your ``_build/build/`` directory. -.. _Debugging with GDB or LLDB: http://opendylan.org/documentation/getting-started-cli/debugging-with-gdb-lldb.html +.. _Debugging with GDB or LLDB: https://opendylan.org/documentation/getting-started-cli/debugging-with-gdb-lldb.html diff --git a/documentation/source/hacker-guide/topics/making-a-release.rst b/documentation/source/hacker-guide/topics/making-a-release.rst index 49fcba53aa..3ed2b639cb 100644 --- a/documentation/source/hacker-guide/topics/making-a-release.rst +++ b/documentation/source/hacker-guide/topics/making-a-release.rst @@ -32,9 +32,8 @@ now here is a manual check-list. * Run ``make check`` and if anything fails that is not marked ``EXPECTED TO FAIL``, fix the problem or discuss with others how to proceed. - * As a smoke test, verify that the `"Hello World" instructions - <https://opendylan.org/getting-started-cli/hello-world.html>`_ work on - each platform. + * As a smoke test, verify that the :doc:`"Hello World" instructions + </getting-started-cli/hello-world>` work on each platform. **TODO:** This should be done automatically by GitHub CI. See https://github.com/dylan-lang/opendylan/blob/master/.github/workflows/bootstrap.yml @@ -111,7 +110,7 @@ now here is a manual check-list. backup on a server that we own.) #. Update the `Downloads - <https://github.com/dylan-lang/website/blob/master/source/download/index.rst>`_ + <https://github.com/dylan-lang/opendylan/blob/master/documentation/source/download/index.rst>`_ page. #. On GitHub, move the release from Draft to Final. diff --git a/documentation/source/hacker-guide/topics/method-dispatch.rst b/documentation/source/hacker-guide/topics/method-dispatch.rst index 517130c99b..622efc280c 100644 --- a/documentation/source/hacker-guide/topics/method-dispatch.rst +++ b/documentation/source/hacker-guide/topics/method-dispatch.rst @@ -225,15 +225,15 @@ Future Work but that aren't understood well (like dispatch profiling). * Much more documentation. -.. _sources/dylan/discrimination.dylan: https://github.com/dylan-lang/opendylan/tree/master/sources/dylan/discrimination.dylan -.. _sources/dylan/dispatch-caches.dylan: https://github.com/dylan-lang/opendylan/tree/master/sources/dylan/dispatch-caches.dylan -.. _sources/dylan/dispatch-prologue.dylan: https://github.com/dylan-lang/opendylan/tree/master/sources/dylan/dispatch-prologue.dylan -.. _sources/dylan/dispatch.dylan: https://github.com/dylan-lang/opendylan/tree/master/sources/dylan/dispatch.dylan -.. _sources/dylan/new-dispatch.dylan: https://github.com/dylan-lang/opendylan/tree/master/sources/dylan/new-dispatch.dylan -.. _sources/dylan/slot-dispatch.dylan: https://github.com/dylan-lang/opendylan/tree/master/sources/dylan/slot-dispatch.dylan -.. _sources/dfmc/modeling/functions.dylan: https://github.com/dylan-lang/opendylan/tree/master/sources/dfmc/modeling/functions.dylan -.. _sources/dfmc/optimization/dispatch.dylan: https://github.com/dylan-lang/opendylan/tree/master/sources/dfmc/optimization/dispatch.dylan -.. _sources/dfmc/management/compilation-driver.dylan: https://github.com/dylan-lang/opendylan/tree/master/sources/dfmc/management/compilation-driver.dylan -.. _sources/environment/deuce/dylanworks-mode.dylan: https://github.com/dylan-lang/opendylan/tree/master/sources/environment/deuce/dylanworks-mode.dylan -.. _sources/project-manager/projects/implementation.dylan: https://github.com/dylan-lang/opendylan/tree/master/sources/project-manager/projects/implementation.dylan -.. _sources/lib/dispatch-profiler: https://github.com/dylan-lang/opendylan/tree/master/sources/lib/dispatch-profiler +.. _sources/dylan/discrimination.dylan: https://github.com/dylan-lang/opendylan/blob/master/sources/dylan/discrimination.dylan +.. _sources/dylan/dispatch-caches.dylan: https://github.com/dylan-lang/opendylan/blob/master/sources/dylan/dispatch-caches.dylan +.. _sources/dylan/dispatch-prologue.dylan: https://github.com/dylan-lang/opendylan/blob/master/sources/dylan/dispatch-prologue.dylan +.. _sources/dylan/dispatch.dylan: https://github.com/dylan-lang/opendylan/blob/master/sources/dylan/dispatch.dylan +.. _sources/dylan/new-dispatch.dylan: https://github.com/dylan-lang/opendylan/blob/master/sources/dylan/new-dispatch.dylan +.. _sources/dylan/slot-dispatch.dylan: https://github.com/dylan-lang/opendylan/blob/master/sources/dylan/slot-dispatch.dylan +.. _sources/dfmc/modeling/functions.dylan: https://github.com/dylan-lang/opendylan/blob/master/sources/dfmc/modeling/functions.dylan +.. _sources/dfmc/optimization/dispatch.dylan: https://github.com/dylan-lang/opendylan/blob/master/sources/dfmc/optimization/dispatch.dylan +.. _sources/dfmc/management/compilation-driver.dylan: https://github.com/dylan-lang/opendylan/blob/master/sources/dfmc/management/compilation-driver.dylan +.. _sources/environment/deuce/dylanworks-mode.dylan: https://github.com/dylan-lang/opendylan/blob/master/sources/environment/deuce/dylanworks-mode.dylan +.. _sources/project-manager/projects/implementation.dylan: https://github.com/dylan-lang/opendylan/blob/master/sources/project-manager/projects/implementation.dylan +.. _sources/lib/dispatch-profiler: https://github.com/dylan-lang/opendylan/blob/master/sources/lib/dispatch-profiler diff --git a/documentation/source/history/index.rst b/documentation/source/history/index.rst index 020113fe61..6bf55d99cf 100644 --- a/documentation/source/history/index.rst +++ b/documentation/source/history/index.rst @@ -106,7 +106,7 @@ it as: part of this templating processing. Some additional details about the early design of HARP are available in -`Techniques for Dynamic Software Migration <http://citeseerx.ist.psu.edu/viewdoc/summary?doi=10.1.1.47.2525>`_ +`Techniques for Dynamic Software Migration <https://citeseerx.ist.psu.edu/viewdoc/summary?doi=10.1.1.47.2525>`_ from 1988. Other early sources of information about it, written by Hunter and Knightbridge, appear to be lost to the sands of time. @@ -141,7 +141,7 @@ Scott McKay also worked on the Deuce editor that was used in the DylanWorks IDE. He wrote about it briefly in a `newsgroup posting <https://groups.google.com/forum/#!msg/comp.lang.dylan/3uuUb3Z9pAc/6NbE9gYpeAIJ>`_. Bruce Mitchener also wrote briefly about the architecture of Deuce on the -`Atom editor discussion forums <http://web.archive.org/web/20210407151341/https://discuss.atom.io/t/the-deuce-editor-architecture/2218>`_. +`Atom editor discussion forums <https://web.archive.org/web/20210407151341/https://discuss.atom.io/t/the-deuce-editor-architecture/2218>`_. Memory Pool System ------------------ @@ -229,7 +229,7 @@ Over the years, there have been a variety of other Dylan implementations. <https://groups.csail.mit.edu/mac/ftpdir/scheme-mail/HTML/rrrs-1992/msg00197.html>`_. * In 1994, Jonathan Bachrach had an implementation written on top of CMUCL using a set of macros. This implementation has been lost. -* The `Marlais <http://marlais.sourceforge.net/>`_ implementation was +* The `Marlais <https://marlais.sourceforge.net/>`_ implementation was abandoned in 2001. * Dominique Boucher wrote `IDyl <https://github.com/schemeway/idyl>`_, a Dylan interpreter in Scheme in the mid-1990s. diff --git a/documentation/source/intro-dylan/methods-generic-functions.rst b/documentation/source/intro-dylan/methods-generic-functions.rst index 233dbdf870..463a19ff7f 100644 --- a/documentation/source/intro-dylan/methods-generic-functions.rst +++ b/documentation/source/intro-dylan/methods-generic-functions.rst @@ -187,7 +187,7 @@ over" (or captures the binding of) the variable named ``string``. Generic Functions ================= -A :drm:`generic function` represents zero or more +A :drm:`<generic-function>` represents zero or more similar methods. Every method created by means of :drm:`define method` is automatically contained within the generic function of the same name. For example, a diff --git a/documentation/source/library-reference/c-ffi/index.rst b/documentation/source/library-reference/c-ffi/index.rst index a6febf0308..7f47b3fe9e 100644 --- a/documentation/source/library-reference/c-ffi/index.rst +++ b/documentation/source/library-reference/c-ffi/index.rst @@ -2436,7 +2436,7 @@ Defining specialized designator classes [`type-options`] end - :parameter modifiers: The same as the modifiers allowed in :drm:`define-class`. + :parameter modifiers: The same as the modifiers allowed in :drm:`define class`. :parameter type-name: A Dylan variable name. :parameter superclasses: A list of Dylan names. :parameter high-level-type: An instance of a Dylan :drm:`<type>`. diff --git a/documentation/source/library-reference/common-dylan/common-extensions.rst b/documentation/source/library-reference/common-dylan/common-extensions.rst index 4d2f85889e..7bb3fffe67 100644 --- a/documentation/source/library-reference/common-dylan/common-extensions.rst +++ b/documentation/source/library-reference/common-dylan/common-extensions.rst @@ -789,7 +789,7 @@ The extensions are: :operations: - :drm:`condition-format-string` - - :drm:`condition-format-args` + - :drm:`condition-format-arguments` .. class:: <stretchy-sequence> :open: @@ -1613,7 +1613,7 @@ The extensions are: Parses the command specified in *line* into a command name and arguments. The rules used to tokenize the string are given in Microsoft's C/C++ reference in the section `"Parsing C Command-Line - Arguments" <http://msdn.microsoft.com/en-us/library/a1y7w461.aspx>`_. + Arguments" <https://learn.microsoft.com/en-us/cpp/c-language/parsing-c-command-line-arguments?view=msvc-170>`_. :seealso: diff --git a/documentation/source/library-reference/common-dylan/index.rst b/documentation/source/library-reference/common-dylan/index.rst index 169f2fdc8d..b5c7375e1a 100644 --- a/documentation/source/library-reference/common-dylan/index.rst +++ b/documentation/source/library-reference/common-dylan/index.rst @@ -29,6 +29,6 @@ that is very widely used. It also re-exports these modules which are defined in :doc:`the dylan library <../dylan/index>`: -- `The dylan Module <http://opendylan.org/books/drm/>`_ +- `The dylan Module </books/drm/>`_ - :doc:`../dylan/threads` - :doc:`../dylan/finalization` diff --git a/documentation/source/library-reference/dylan/finalization.rst b/documentation/source/library-reference/dylan/finalization.rst index c9117017cb..70fce8f914 100644 --- a/documentation/source/library-reference/dylan/finalization.rst +++ b/documentation/source/library-reference/dylan/finalization.rst @@ -14,7 +14,7 @@ to use the interface described in this documentation. What is finalization? ===================== -The `Memory Management Reference <http://www.memorymanagement.org>`_ defines +The `Memory Management Reference <https://www.memorymanagement.org>`_ defines finalization as follows: In garbage-collected languages, it is often necessary to perform actions diff --git a/documentation/source/library-reference/index.rst b/documentation/source/library-reference/index.rst index 2aff7f70d7..945364e9f8 100644 --- a/documentation/source/library-reference/index.rst +++ b/documentation/source/library-reference/index.rst @@ -5,7 +5,7 @@ This reference describes the libraries provided with Open Dylan, either as part of the "opendylan" repository or included therein as submodules. It also documents Dylan language extensions and the LID file format. -See the :doc:`Dylan Package Docs <../package/index>` for documentation +See the `Dylan Package Docs <https://opendylan.org/package/>`_ for documentation on published Dylan packages. Contents: diff --git a/documentation/source/library-reference/io/streams.rst b/documentation/source/library-reference/io/streams.rst index 532cc696ad..963f70689b 100644 --- a/documentation/source/library-reference/io/streams.rst +++ b/documentation/source/library-reference/io/streams.rst @@ -1898,7 +1898,7 @@ are exported from the *streams* module. The type of the result string is chosen so that the string can contain characters of *input-stream* 's element type. For example, - if the element type is `<byte-character>`_, the string will be a + if the element type is :type:`<byte-character>`, the string will be a :drm:`<byte-string>`. If *input-stream* is at its end immediately upon calling @@ -2891,7 +2891,7 @@ are exported from the *streams* module. :statement: Provides a convenient way of returning a :drm:`<string>` after - performing a series of operations on a :drm:`<stream>`, and then + performing a series of operations on a :class:`<stream>`, and then close the stream. :macrocall: diff --git a/documentation/source/library-reference/system/date.rst b/documentation/source/library-reference/system/date.rst index c9bfcd5353..723d5fb435 100644 --- a/documentation/source/library-reference/system/date.rst +++ b/documentation/source/library-reference/system/date.rst @@ -590,7 +590,7 @@ Date module. .. function:: as-rfc822-string Returns a string representation of a date, conforming to - `RFC 822 <http://www.w3.org/Protocols/rfc822/#z28>`_. + `RFC 822 <https://www.w3.org/Protocols/rfc822/#z28>`_. :signature: as-rfc822-string *date* => *rfc822-string* @@ -1468,7 +1468,7 @@ Date module. * the date and time may be separated by a space character * TZD may be preceded by a space character - See http://www.w3.org/TR/NOTE-datetime.html. + See https://www.w3.org/TR/NOTE-datetime.html. Year: YYYY (eg 1997) diff --git a/documentation/source/library-reference/system/file-system.rst b/documentation/source/library-reference/system/file-system.rst index 36d63516a1..4c2245662d 100644 --- a/documentation/source/library-reference/system/file-system.rst +++ b/documentation/source/library-reference/system/file-system.rst @@ -970,7 +970,7 @@ File-System module. represented abstractly; for instance, contiguous elements could be treated as a single database record. This init-keyword defaults to something useful, potentially based on the properties of the file; - `<byte-character>`_ and `<unicode-character>`_ are likely choices. + :type:`<byte-character>` and :type:`<unicode-character>` are likely choices. See `Options when creating file streams`_. :seealso: diff --git a/documentation/source/man-pages/dylan-compiler.rst b/documentation/source/man-pages/dylan-compiler.rst index 3a826330ce..ff28cef1e2 100644 --- a/documentation/source/man-pages/dylan-compiler.rst +++ b/documentation/source/man-pages/dylan-compiler.rst @@ -25,7 +25,7 @@ The following options are among those available: See ``dylan-compiler -help`` for a full listing of the options. -See https://opendylan.org/documentation/getting-started-cli/ for more +See https://opendylan.org/getting-started-cli/ for more details on the usage of the ``dylan-compiler`` command line tool. SEE ALSO diff --git a/documentation/source/news/2011/12/10/new_release.rst b/documentation/source/news/2011/12/10/new_release.rst index 83d601debb..df6bdbafb9 100644 --- a/documentation/source/news/2011/12/10/new_release.rst +++ b/documentation/source/news/2011/12/10/new_release.rst @@ -28,7 +28,7 @@ Another big effort was made to decrease the size of the code base in order to improve its maintainability. In this release, compared to (the unannounced) beta5, we removed about 1/3 of the code base, from 1,200,000 lines of code down to 850,000 (according to -https://www.openhub.net/p/open-dylan). +https://openhub.net/p/open-dylan). This is the first joint release on all major platforms: diff --git a/documentation/source/news/2012/01/25/c3.rst b/documentation/source/news/2012/01/25/c3.rst index 5cfe7b79d2..81f3d2b4ef 100644 --- a/documentation/source/news/2012/01/25/c3.rst +++ b/documentation/source/news/2012/01/25/c3.rst @@ -15,5 +15,5 @@ issued if the new C3 linearization is different from the old `linearization specified in the DRM <https://opendylan.org/books/drm/Classes#HEADING-41-25>`_. -Further information is available in `the accepted Dylan enhancement -proposal </proposals/dep-0003-c3-linearization.html>`_. +Further information is available in :doc:`the accepted Dylan Enhancement +Proposal 3 </proposals/dep-0003-c3-linearization>`. diff --git a/documentation/source/news/2012/10/15/command-line-parser.rst b/documentation/source/news/2012/10/15/command-line-parser.rst index c4bed13ece..cab07f0935 100644 --- a/documentation/source/news/2012/10/15/command-line-parser.rst +++ b/documentation/source/news/2012/10/15/command-line-parser.rst @@ -12,7 +12,7 @@ completely rewritten to * be far less verbose * have simplified usage * have automatic support for --help - * be `documented </library-reference/command-line-parser/index.html>`_ + * be `documented <https://opendylan.org/package/command-line-parser/>`_ Testworks and the HTTP server are using the new library. More enhancements coming soon. diff --git a/documentation/source/news/2012/12/20/new-release.rst b/documentation/source/news/2012/12/20/new-release.rst index 051393f1b4..459d91144f 100644 --- a/documentation/source/news/2012/12/20/new-release.rst +++ b/documentation/source/news/2012/12/20/new-release.rst @@ -14,12 +14,12 @@ For a variety of reasons, we didn't get to carry out our plan for more frequent releases in 2012, but hope to have more frequent releases in 2013. -While we have extensive `release notes </release-notes/2012.1.html>`_, +While we have extensive :doc:`release notes </release-notes/2012.1>`, there are some important changes that we feel are worth calling out separately: -* We now use the C3 superclass linearization. See `DEP-0003 - </proposals/dep-0003-c3-linearization.html>`_ for more details. +* We now use the C3 superclass linearization. See :doc:`DEP-0003 + </proposals/dep-0003-c3-linearization>` for more details. * Multithreading now works in the C backend. * Binaries and libraries built by ``dylan-compiler`` no longer have their directory location hard-coded within the executables. diff --git a/documentation/source/news/2013/07/11/new-release.rst b/documentation/source/news/2013/07/11/new-release.rst index 73f051b7f4..1c168f4980 100644 --- a/documentation/source/news/2013/07/11/new-release.rst +++ b/documentation/source/news/2013/07/11/new-release.rst @@ -9,7 +9,7 @@ Dear Dylan Hacker, It is a pleasure for us to announce a new release of Open Dylan. -We have extensive `release notes </release-notes/2013.1.html>`_, +We have extensive :doc:`release notes </release-notes/2013.1>`, but this release has been about iterative improvement rather than major changes. * A deadlock when using threads on x86-linux has been addressed. diff --git a/documentation/source/news/2013/08/15/duim-gtk.rst b/documentation/source/news/2013/08/15/duim-gtk.rst index 53f52c3c43..f0a871d893 100644 --- a/documentation/source/news/2013/08/15/duim-gtk.rst +++ b/documentation/source/news/2013/08/15/duim-gtk.rst @@ -10,34 +10,30 @@ Bringing back DUIM/Gtk Lately, we've been working on bringing back DUIM's GTK+ back-end. -`DUIM`_ is Dylan's user interface framework. While it was -originally cross-platform, the only back-end that works now -is for Windows. Bringing back the GTK+ back-end and completing -it will enable us to support Linux, FreeBSD and perhaps Mac OS X. +:doc:`DUIM </building-with-duim/index>` is Dylan's user interface framework. While +it was originally cross-platform, the only back-end that works now is for +Windows. Bringing back the GTK+ back-end and completing it will enable us to +support Linux, FreeBSD and perhaps Mac OS X. -This is a great first step towards making the `IDE`_ more widely -available. Apart from being able to use the IDE on additional -platforms, which is great in and of itself, having the IDE available to -more of us makes it easier to fix bugs and improve the functionality -as most of us aren't working on the Windows platform. +This is a great first step towards making the :doc:`IDE +</getting-started-ide/index>` more widely available. Apart from being able to use +the IDE on additional platforms, which is great in and of itself, having the +IDE available to more of us makes it easier to fix bugs and improve the +functionality as most of us aren't working on the Windows platform. So far, we have a new set of GTK+ bindings for GTK+ 3.x available in `sources/gtk`_ and have begun the work to update the old `DUIM GTK+`_ back-end and make further improvements. -At this point, we would welcome some assistance. There are -further improvements to make to the GTK+ bindings and a lot of -work to do on DUIM/Gtk. (We have started building a -`list of bugs`_.) We've also started to collect some notes -for the `hacker's guide`_, especially for working on Mac OS X. +At this point, we would welcome some assistance. There are further improvements +to make to the GTK+ bindings and a lot of work to do on DUIM/Gtk. (We have +started building a `list of bugs`_.) We've also started to collect some notes +for the :doc:`Hacker Guide </hacker-guide/duim/index>`, especially for working on +Mac OS X. If you're interested in learning more or helping out, get -in touch with us on `chat or the mailing list`_! +in touch with us on :doc:`chat or the mailing list </community/index>`! -.. _DUIM: /building-with-duim/index.html -.. _IDE: /getting-started-ide/index.html .. _sources/gtk: https://github.com/dylan-lang/opendylan/tree/master/sources/gtk .. _DUIM GTK+: https://github.com/dylan-lang/opendylan/tree/master/sources/duim/gtk .. _list of bugs: https://github.com/dylan-lang/opendylan/labels/lib-DUIM%20%2F%20Gtk -.. _hacker's guide: /hacker-guide/duim/index.html -.. _chat or the mailing list: /community/ diff --git a/documentation/source/news/2013/12/23/new-release.rst b/documentation/source/news/2013/12/23/new-release.rst index 2dd46a0fa0..4c4d3aa527 100644 --- a/documentation/source/news/2013/12/23/new-release.rst +++ b/documentation/source/news/2013/12/23/new-release.rst @@ -13,7 +13,7 @@ Dylan is a multi-paradigm functional and object-oriented programming language. I For more information on Open Dylan, see our `website <https://opendylan.org/>`_ and our `documentation <https://opendylan.org/documentation/>`_. -We have extensive `release notes <https://opendylan.org/documentation/release-notes/2013.2.html>`_, +We have extensive :doc:`release notes </release-notes/2013.2>`, but this release has been about iterative improvement rather than major changes. * Testworks has seen substantial improvements. diff --git a/documentation/source/news/2015/01/01/new-release.rst b/documentation/source/news/2015/01/01/new-release.rst index 74479c9521..4dc6d7189a 100644 --- a/documentation/source/news/2015/01/01/new-release.rst +++ b/documentation/source/news/2015/01/01/new-release.rst @@ -13,7 +13,7 @@ Dylan is a multi-paradigm functional and object-oriented programming language. I For more information on Open Dylan, see our `website <https://opendylan.org/>`_ and our `documentation <https://opendylan.org/documentation/>`_. -We have extensive `release notes <https://opendylan.org/documentation/release-notes/2014.1.html>`_, but highlights include: +We have extensive :doc:`release notes </release-notes/2014.1>`, but highlights include: * bash completion scripts are available. * The foundation of an Objective C / Dylan bridge has been integrated with the compiler. @@ -26,7 +26,7 @@ We have extensive `release notes <https://opendylan.org/documentation/release-no Please report problems that you have in our `issue tracker <https://github.com/dylan-lang/opendylan/issues>`_. -You can get it from our website, `https://opendylan.org/download/ <https://opendylan.org/download/>`_. +You can get it from our website, https://opendylan.org/. On Windows there is an installer, on UNIX systems unpack into ``/opt``. On 64 bit Linux, you will need to have the Boehm GC installed for our executables to run. (Ubuntu: ``apt-get install libgc``) diff --git a/documentation/source/news/2019/03/31/new-release.rst b/documentation/source/news/2019/03/31/new-release.rst index 084a87e0ac..2d19fab2d5 100644 --- a/documentation/source/news/2019/03/31/new-release.rst +++ b/documentation/source/news/2019/03/31/new-release.rst @@ -29,11 +29,10 @@ platforms. Other highlights include: * A new ``lldb`` wrapper script that preloads the Dylan integration scripts. * Run-time primitives to aid in profiling and event logging. -For full details on changes in this release see the `release notes -<https://opendylan.org/documentation/release-notes/2019.1.html>`_, or go -directly to the `download page <https://opendylan.org/download/index.html>`_. +For full details on changes in this release see the :doc:`release notes +</release-notes/2019.1>`, or go +directly to the :doc:`download page </download/index>`. -For more information on Open Dylan, see our `website <https://opendylan.org/>`_ -and our `documentation <https://opendylan.org/documentation/>`_. +For more information on Open Dylan, see https://opendylan.org/. Good luck and happy Dylan hacking! diff --git a/documentation/source/news/2020/10/10/new-release.rst b/documentation/source/news/2020/10/10/new-release.rst index ab60d5a5d5..13e826d073 100644 --- a/documentation/source/news/2020/10/10/new-release.rst +++ b/documentation/source/news/2020/10/10/new-release.rst @@ -37,11 +37,10 @@ Some highlights in this release: * Testworks now generates reports in JSON format, along with other Testworks improvements. -For full details on changes in this release see the `release notes -<https://opendylan.org/documentation/release-notes/2020.1.html>`_, or go -directly to the `download page <https://opendylan.org/download/index.html>`_. +For full details on changes in this release see the :doc:`release notes +</release-notes/2020.1>`, or go +directly to the :doc:`download page </download/index>`. -For more information on Open Dylan, see our `website <https://opendylan.org/>`_ -and our `documentation <https://opendylan.org/documentation/>`_. +For more information on Open Dylan, see our https://opendylan.org/. Good luck and happy Dylan hacking! diff --git a/documentation/source/news/2022/11/28/new-release.rst b/documentation/source/news/2022/11/28/new-release.rst index 824d3dd0ca..6cb479bd11 100644 --- a/documentation/source/news/2022/11/28/new-release.rst +++ b/documentation/source/news/2022/11/28/new-release.rst @@ -31,11 +31,10 @@ Some highlights in this release: * Updates to various libraries included with Open Dylan: collections, io, system, ssl, testworks. -For full details on changes in this release see the `release notes -<https://opendylan.org/documentation/release-notes/2022.1.html>`_, or go -directly to the `download page <https://opendylan.org/download/index.html>`_. +For full details on changes in this release see the :doc:`release notes +</release-notes/2022.1>`, or go +directly to the :doc:`download page </download/index>`. -For more information on Open Dylan, see our `website <https://opendylan.org/>`_ -and our `documentation <https://opendylan.org/documentation/>`_. +For more information on Open Dylan, see https://opendylan.org/. Good luck and happy Dylan hacking! diff --git a/documentation/source/news/index.rst b/documentation/source/news/index.rst index 786fe96202..d3a146da3b 100644 --- a/documentation/source/news/index.rst +++ b/documentation/source/news/index.rst @@ -13,8 +13,8 @@ Release 2023.1 * Updated versions of LLVM and the BDW garbage collector. * New ``"""multi-line"""`` and ``#r"raw"`` string literals (`DEP 12 <../proposals/dep-0012-string-literals.rst>`_). -* The :doc:`dylan <../package/dylan-tool/index>` tool continues to evolve with - a new, simplified workspace model. +* The `dylan <https://opendylan.org/package/dylan-tool/>`_ tool continues to + evolve with a new, simplified workspace model. * Bug fixes for json, command-line-parser, system, and others. See the `release notes <../release-notes/2023.1.rst>`_ for more details. @@ -38,7 +38,7 @@ overhaul. The goals of this revamp were: #. Local table of contents in the right sidebar. Hooray `Furo <https://pradyunsg.me/furo/quickstart/>`_! -#. Integrated :doc:`package docs <../package/index>`. +#. Integrated `package docs <https://opendylan.org/package/>`_. #. Simplicity! We're a small team so we want to avoid any extra maintenance burden. To that end, we no longer use a Dylan-specific Sphinx theme or @@ -46,7 +46,7 @@ overhaul. The goals of this revamp were: we don't want it! :-) We'd love to hear feedback on the new site. You can `file a bug -<https://github.com/dylan-lang/website/issues>`_ or `drop us a note on Matrix +<https://github.com/dylan-lang/opendylan/issues>`_ or `drop us a note on Matrix <https://app.element.io/#/room/#dylan-language:matrix.org>`_. diff --git a/documentation/source/proposals/dep-0001-dep-process.rst b/documentation/source/proposals/dep-0001-dep-process.rst index 18cb512b0c..a9133cc246 100644 --- a/documentation/source/proposals/dep-0001-dep-process.rst +++ b/documentation/source/proposals/dep-0001-dep-process.rst @@ -17,7 +17,7 @@ Preamble ======== This document is based heavily on Python `PEP 1 -<https://www.python.org/dev/peps/pep-0001/>`_, "PEP Purpose and +<https://peps.python.org/pep-0001/>`_, "PEP Purpose and Guidelines", by Barry Warsaw, Jeremy Hylton, and David Goodger. The author would like to thank them for providing an excellent base for the Dylan team to work from. @@ -136,7 +136,7 @@ the next available DEP number to the DEP by looking at the :doc:`DEP directory <index>` to find the highest used number. The DEP number is not assured until the DEP has been committed to the `origin Git repository -<https://github.com/dylan-lang/website/tree/master/source/proposals>`_. +<https://github.com/dylan-lang/opendylan/tree/master/documentation/source/proposals>`_. As updates are necessary, the DEP author may commit new versions. Wait for at least ten days to receive feedback on each draft. @@ -487,7 +487,7 @@ References and Footnotes .. [1] This historical record is available by the normal Git commands for retrieving older revisions. For those without direct access to Git, you can browse the current and past DEP revisions here: - https://github.com/dylan-lang/website/tree/master/source/proposals + https://github.com/dylan-lang/opendylan/tree/master/documentation/source/proposals .. [2] Which issue tracker to use will depend on the content of the DEP. For language changes, changes to Open Dylan, or changes to diff --git a/documentation/source/proposals/dep-0006-single-file-library.rst b/documentation/source/proposals/dep-0006-single-file-library.rst index a80cf81fb7..f43a4c05c1 100644 --- a/documentation/source/proposals/dep-0006-single-file-library.rst +++ b/documentation/source/proposals/dep-0006-single-file-library.rst @@ -18,7 +18,7 @@ Revision History ================ The revision history of this document is available on GitHub: -https://github.com/dylan-lang/website/commits/master/source/proposals/dep-0006-single-file-library.rst +https://github.com/dylan-lang/opendylan/commits/master/documentation/source/proposals/dep-0006-single-file-library.rst Abstract ======== @@ -173,7 +173,7 @@ single source file, all LID keywords may appear in the header section. The compiler or interpreter should handle them in the same way it would if they were in a separate .lid file. There is no conflict between the keywords used in LID files and those used in Dylan source -files. See https://opendylan.org/documentation/library-reference/lid.html +files. See :doc:`/library-reference/lid` for existing Open Dylan LID file keywords. Module Header diff --git a/documentation/source/proposals/dep-0008-multi-line-strings.rst b/documentation/source/proposals/dep-0008-multi-line-strings.rst index da2e7ba894..31f271a9f3 100644 --- a/documentation/source/proposals/dep-0008-multi-line-strings.rst +++ b/documentation/source/proposals/dep-0008-multi-line-strings.rst @@ -120,4 +120,4 @@ Revision History ================ The revision history of this document is available here: -https://github.com/dylan-lang/website/commits/master/source/proposals/dep-0008-multi-line-strings.rst +https://github.com/dylan-lang/opendylan/commits/master/documentation/source/proposals/dep-0008-multi-line-strings.rst diff --git a/documentation/source/proposals/dep-0010-element-otherwise.rst b/documentation/source/proposals/dep-0010-element-otherwise.rst index f5a98f20e5..19ba2b15e3 100644 --- a/documentation/source/proposals/dep-0010-element-otherwise.rst +++ b/documentation/source/proposals/dep-0010-element-otherwise.rst @@ -18,7 +18,7 @@ Revision History ================ The revision history of this document is available here: -https://github.com/dylan-lang/website/commits/master/source/proposals/dep-0010-element-otherwise.rst +https://github.com/dylan-lang/opendylan/commits/master/documentation/source/proposals/dep-0010-element-otherwise.rst Abstract ======== diff --git a/documentation/source/proposals/dep-0012-string-literals.rst b/documentation/source/proposals/dep-0012-string-literals.rst index 3de39f2246..30b4d36796 100644 --- a/documentation/source/proposals/dep-0012-string-literals.rst +++ b/documentation/source/proposals/dep-0012-string-literals.rst @@ -70,8 +70,8 @@ characters. The primary example of this is regular expressions, which quickly become difficult to interpret when they themselves contain many backslashes. Open Dylan has a fairly simple work-around for this problem, which it calls -`parser expansions -<https://opendylan.org/documentation/library-reference/language-extensions/parser-expansions.html>`_:: +:doc:`parser expansions +</library-reference/language-extensions/parser-expansions>`:: define function string-parser (s) s end; define constant s1 = "\\.\\[\\*\\\\\\]"; // standard Dylan @@ -355,4 +355,4 @@ Revision History ================ The revision history of this document is available here: -https://github.com/dylan-lang/website/commits/master/source/proposals/dep-0012-string-literals.rst +https://github.com/dylan-lang/opendylan/commits/master/documentation/source/proposals/dep-0012-string-literals.rst diff --git a/documentation/source/proposals/index.rst b/documentation/source/proposals/index.rst index 5947642fdf..e3ec3321fb 100644 --- a/documentation/source/proposals/index.rst +++ b/documentation/source/proposals/index.rst @@ -24,8 +24,8 @@ building consensus within the community and documenting dissenting opinions. Because the DEPs are maintained as text files in a versioned repository, their `revision history -<https://github.com/dylan-lang/website/tree/master/source/proposals>`_ is the -historical record of the feature proposal. +<https://github.com/dylan-lang/opendylan/tree/master/documentation/source/proposals>`_ +is the historical record of the feature proposal. For more information on the DEP process, see DEP 1, :doc:`dep-0001-dep-process`. diff --git a/documentation/source/release-notes/2011.1.rst b/documentation/source/release-notes/2011.1.rst index 7f4f397bd7..efcce80c51 100644 --- a/documentation/source/release-notes/2011.1.rst +++ b/documentation/source/release-notes/2011.1.rst @@ -1,4 +1,4 @@ Open Dylan 2011.1 Release Notes =============================== -See the `announcement <http://opendylan.org/news/2011/12/10/new_release.html>`_. +See the `announcement <https://opendylan.org/news/2011/12/10/new_release.html>`_. diff --git a/documentation/source/release-notes/2012.1.rst b/documentation/source/release-notes/2012.1.rst index 890254a857..0332163cd2 100644 --- a/documentation/source/release-notes/2012.1.rst +++ b/documentation/source/release-notes/2012.1.rst @@ -30,7 +30,7 @@ Introduction This document describes the 2012.1 release of Open Dylan, released December 19, 2012. -* `Download the release <http://opendylan.org/download/index.html>`_ +* `Download the release <https://opendylan.org/download/index.html>`_ * `Report bugs <https://github.com/dylan-lang/opendylan/issues>`_ * `Source code <https://github.com/dylan-lang/opendylan/tree/v2012.1>`_ @@ -51,8 +51,7 @@ the compiler will issue a serious warning. In a future release this will be changed to non-serious warning, and then eventually the warning will be removed completely. -See `DEP-0003 <http://opendylan.org/proposals/dep-0003.html>`_ for -more details. +See :doc:`DEP-0003 </proposals/dep-0003-c3-linearization>` for more details. Library Changes @@ -62,7 +61,7 @@ Library Changes Any usages of it can be replaced by using the ``plists`` module from the ``collections`` library. Additionally, the ``plists`` module has been `documented - <http://opendylan.org/documentation/library-reference/collections/plists.html>`_. + <https://opendylan.org/library-reference/collections/plists.html>`_. * Support for MacOS 9 locators has been removed. This is pre-OS X code and we don't support Mac OS 9 as a platform. @@ -83,8 +82,8 @@ Library Changes * A new ``strings`` library replaces the ``string-extensions`` library. The new library provides a simpler API with all names - exported from a single ``strings`` module. `DEP-0004 - <http://opendylan.org/proposals/dep-0004.html>`_ is currently the + exported from a single ``strings`` module. :doc:`DEP-0004 + </proposals/dep-0004-strings-library>` is currently the best documentation for this library. * The ``string-extensions`` library has been removed. Use the @@ -114,16 +113,13 @@ Documentation Improvements documentation up-to-date, modernizes its look and feel, and allows us to generate various output formats. -* The core libraries documentation has been unified into one `Dylan - Library Reference - <http://opendylan.org/documentation/library-reference/index.html>`_ - document. +* The core libraries documentation has been unified into one :doc:`Dylan + Library Reference </library-reference/index>` document. * The documentation on using the Open Dylan Console Environment has been rewritten and expanded. A new section on the Dylan Interaction - Mode for Emacs (DIME) has been added. See both in `the Getting - Started Guide - <http://opendylan.org/documentation/getting-started/index.html>`_. + Mode for Emacs (DIME) has been added. See both in :doc:`the Getting + Started Guide </getting-started-cli/index>`. dylan-compiler Improvements diff --git a/documentation/source/release-notes/2013.2.rst b/documentation/source/release-notes/2013.2.rst index c6fbcd753d..6a27d9244b 100644 --- a/documentation/source/release-notes/2013.2.rst +++ b/documentation/source/release-notes/2013.2.rst @@ -18,13 +18,13 @@ Improvements Documentation ------------- -The `logging <http://opendylan.org/documentation/library-reference/logging/>`_ library has been documented. +The `logging <https://opendylan.org/library-reference/logging/>`_ library has been documented. -The `regular-expressions <http://opendylan.org/documentation/library-reference/regular-expressions/index.html>`_ library documentation has been greatly improved. +The `regular-expressions <https://opendylan.org/library-reference/regular-expressions/index.html>`_ library documentation has been greatly improved. -The `date <http://opendylan.org/documentation/library-reference/system/date.html>`_ module documentation has been improved and now covers date formatting and parsing. +The `date <https://opendylan.org/library-reference/system/date.html>`_ module documentation has been improved and now covers date formatting and parsing. -The `C-FFI <http://opendylan.org/documentation/library-reference/c-ffi/>`_ library now discusses `linking against a library <http://opendylan.org/documentation/library-reference/c-ffi/#notes-on-linking>`_ rather than assuming that people will find the LID file documentation. `Tracing FFI calls <http://opendylan.org/documentation/library-reference/c-ffi/#tracing-ffi-calls>`_ has also been documented. +The `C-FFI <https://opendylan.org/library-reference/c-ffi/>`_ library now discusses `linking against a library <https://opendylan.org/library-reference/c-ffi/#notes-on-linking>`_ rather than assuming that people will find the LID file documentation. `Tracing FFI calls <https://opendylan.org/library-reference/c-ffi/#tracing-ffi-calls>`_ has also been documented. Build Tools ----------- @@ -94,7 +94,7 @@ hash-algorithms ^^^^^^^^^^^^^^^ A hash algorithms library has been added that supports the MD5, SHA-1, SHA256, -SHA384, and SHA512 algorithms. `Documentation <http://opendylan.org/documentation/library-reference/hash-algorithms/>`_ +SHA384, and SHA512 algorithms. `Documentation <https://opendylan.org/package/hash-algorithms/>`_ is available. This library was written by Hannes Mehnert. I/O diff --git a/documentation/source/release-notes/2014.1.rst b/documentation/source/release-notes/2014.1.rst index db7af6e96d..a55d5c6340 100644 --- a/documentation/source/release-notes/2014.1.rst +++ b/documentation/source/release-notes/2014.1.rst @@ -159,7 +159,7 @@ Common Dylan Debugging ========= -* When using `LLDB <http://lldb.llvm.org/>`_ for debugging, Dylan +* When using `LLDB <https://lldb.llvm.org/>`_ for debugging, Dylan support is now available. To use this, you need to import the Python scripts:: @@ -283,5 +283,4 @@ Testworks forward reference". * Benchmarks are once again supported. See the `documentation - <http://opendylan.org/documentation/testworks/usage.html>`_ for - details. + <https://opendylan.org/package/testworks/>`_ for details. diff --git a/documentation/source/release-notes/2019.1.rst b/documentation/source/release-notes/2019.1.rst index 788ffa372e..7482d92b90 100644 --- a/documentation/source/release-notes/2019.1.rst +++ b/documentation/source/release-notes/2019.1.rst @@ -7,8 +7,8 @@ March, 2019. This release contains many enhancements and bug fixes, highlights of which are listed below. For complete details see `the commit logs <https://github.com/dylan-lang/opendylan/compare/v2014.1...v2019.1.0>`_. -* Download the release: http://opendylan.org/download -* Read documentation: http://opendylan.org/documentation +* Download the release: https://opendylan.org/download +* Read documentation: https://opendylan.org * Report problems: https://github.com/dylan-lang/opendylan/issues @@ -337,7 +337,7 @@ coloring-stream Library * A new library for doing colored text output has been added. It currently supports ANSI codes on Unix terminals. It has been - `documented in the library reference`_. + :doc:`documented in the library reference </library-reference/coloring-stream/index>`. variable-search Library ----------------------- diff --git a/documentation/source/release-notes/2020.1.rst b/documentation/source/release-notes/2020.1.rst index 86f252469a..7e19344c8d 100644 --- a/documentation/source/release-notes/2020.1.rst +++ b/documentation/source/release-notes/2020.1.rst @@ -199,20 +199,18 @@ Debugging ========= * The LLDB debugger support has been updated to work with Python 3. For more - information, see `Debugging with GDB or LLDB - <https://opendylan.org/documentation/getting-started-cli/debugging-with-gdb-lldb.html>`_. + information, see :doc:`Debugging with GDB or LLDB + </getting-started-cli/debugging-with-gdb-lldb>`. Documentation ============= -* Dylan Reference Manual links were added to `An Introduction to Dylan - <https://opendylan.org/documentation/intro-dylan/index.html>`_ +* Dylan Reference Manual links were added to :doc:`An Introduction to Dylan + </intro-dylan/index>`. -* Index sections were added to `Getting Started with the Open Dylan - IDE - <https://opendylan.org/documentation/getting-started-ide/index.html>`_, - `Building Applications With DUIM - <https://opendylan.org/documentation/building-with-duim/index.html>`_. +* Index sections were added to :doc:`Getting Started with the Open Dylan IDE + </getting-started-ide/index>`, :doc:`Building Applications With DUIM + </building-with-duim/index>`. Build System ============ @@ -329,15 +327,14 @@ testworks Library * The testworks-specs library has been folded into testworks and has been greatly simplified. See `Interface Specification Suites - <https://opendylan.org/documentation/testworks/usage.html#interface-specification-suites>`_. Note + <https://opendylan.org/package/testworks/usage.html#interface-specification-suites>`_. Note that the new specification suites no longer expect you to define one test per exported name in your interface module. Instead you can write tests in whatever way best suits your needs and the interface specification suite only verifies that the specification matches the implementation. * A new function has been added to retrieve a unique directory for the current - test: `test-temp-directory - <https://opendylan.org/documentation/testworks/reference.html#testworks:testworks:test-temp-directory>`_ + test: :func:`test-temp-directory` * The `--report` command line option now accepts "full" as a value, meaning to display individual assertion results in addition to the normal output. @@ -383,9 +380,8 @@ big-integers library progress-stream library ----------------------- -* `A new library - <https://opendylan.org/documentation/library-reference/progress-stream/index.html>`_ - for displaying text mode progress bars is provided. +* :doc:`A new library </library-reference/progress-stream/index>` for + displaying text mode progress bars is provided. gabriel-benchmarks library -------------------------- diff --git a/documentation/source/release-notes/2022.1.rst b/documentation/source/release-notes/2022.1.rst index 3c8605bb39..f01fd9eec1 100644 --- a/documentation/source/release-notes/2022.1.rst +++ b/documentation/source/release-notes/2022.1.rst @@ -56,9 +56,10 @@ Tooling * The `dylan <https://github.com/dylan-lang/dylan-tool>`_ command is a new tool to manage Dylan packages and workspaces. It provides a centralized catalog of Dylan packages and a way to manage dependencies without resorting to Git - submodules or needing to manually create registry files. See the `dylan-tool - documentation <https://opendylan.org/documentation/dylan-tool>`_ for - details. + submodules or needing to manually create registry files. + + .. note:: Since this release, dylan-tool was renamed to "deft". See the `deft + documentation </package/deft/>` for details. .. note:: This tool is still in the relatively early stages of development. @@ -86,15 +87,15 @@ Documentation ============= * The `Developing Component Software with CORBA - <http://opendylan.org/documentation/opendylan/corba-guide/index.htm>`_ + <https://opendylan.org/opendylan/corba-guide/index.htm>`_ guide has been updated. -* Documentation for the DOOD library has been added to `the library reference - <https://opendylan.org/documentation/library-reference/index.html>`_. +* Documentation for the DOOD library has been added to :doc:`the library + reference </library-reference/dood/index>`. * Documentation for the internal ``access-path`` and ``debugger-manager`` - libraries is now available in the `Open Dylan Hacker's Guide - <https://opendylan.org/documentation/hacker-guide/index.html>`_. + libraries is now available in the :doc:`Open Dylan Hacker's Guide + </hacker-guide/index>`. Library Changes =============== diff --git a/documentation/source/release-notes/2024.2.rst b/documentation/source/release-notes/2024.2.rst index 733ecbb304..a3c11ab480 100644 --- a/documentation/source/release-notes/2024.2.rst +++ b/documentation/source/release-notes/2024.2.rst @@ -51,11 +51,9 @@ Library Updates System ------ -* The `$machine-name:operating-system:system - <https://opendylan.org/library-reference/system/operating-system.html#system:operating-system:$machine-name>`_ - constant has been renamed to `$machine-architecture - <https://opendylan.org/library-reference/system/operating-system.html#system:operating-system:$machine-architecture>`_. - The old name will remain, for backward compatibility. +* The :const:`$machine-name` constant has been renamed to + :const:`$machine-architecture`. The old name will remain, for backward + compatibility. Contributors ============ diff --git a/documentation/source/style-guide/index.rst b/documentation/source/style-guide/index.rst index d23eeb1588..1668703598 100644 --- a/documentation/source/style-guide/index.rst +++ b/documentation/source/style-guide/index.rst @@ -94,8 +94,8 @@ Naming Naming is hard. There is no single rule that works for everything. Here are some rules that should always be followed: -* Follow the `naming conventions in the Dylan Reference Manual - <http://opendylan.org/books/drm/Naming_Conventions>`_. +* Follow the :drm:`naming conventions in the Dylan Reference Manual + <Naming_Conventions>`. * Use lowercase, not uppercase or mixed case.