From 58368807cc15b05afd69bc1ce01b9b3fce6c8bc8 Mon Sep 17 00:00:00 2001 From: bennibbelink <79653949+bennibbelink@users.noreply.github.com> Date: Tue, 8 Oct 2024 16:10:32 -0400 Subject: [PATCH] reference docs with absolute path instead of FQDN --- source/arche/sim_init.rst | 2 +- source/arche/testing.rst | 6 +++--- source/arche/toolkit.rst | 2 +- source/kernel/style_guide.rst | 4 ++-- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/source/arche/sim_init.rst b/source/arche/sim_init.rst index 0a9bbc00..749df73a 100644 --- a/source/arche/sim_init.rst +++ b/source/arche/sim_init.rst @@ -24,7 +24,7 @@ used to automate the generation of code for the following functions: void InitFrom(cyclus::Agent*); When the preprocessor isn't sufficient, read the `API documents -`_ for the functions +`_ for the functions listed above VERY CAREFULLY. There are also a few other functions related to initialization that are important to understand well: diff --git a/source/arche/testing.rst b/source/arche/testing.rst index 70548de0..dc3f0870 100644 --- a/source/arche/testing.rst +++ b/source/arche/testing.rst @@ -278,7 +278,7 @@ The parameters that can be set (or not) for each source/sink are: * ``lifetime(int)``: The number of time steps the source/sink is deployed until automatic decommissioning. Default is infinite (never decommissioned). -For more details, you can read the `MockSim API docs `_. +For more details, you can read the `MockSim API docs `_. Querying simulation results can be accomplished by getting a reference to the in-memory database generated. Not all data that is present in normal full-stack simulations is available. However, most of the key core tables are @@ -307,9 +307,9 @@ a sample query and test you might write using the gtest framework: EXPECT_DOUBLE_EQ(9.5, mq.mass(922380000)); You can read API documentation for the `queryable database -`_ and +`_ and `query results -`_ for more +`_ for more details. Debugging diff --git a/source/arche/toolkit.rst b/source/arche/toolkit.rst index d8f821f7..782d4cb5 100644 --- a/source/arche/toolkit.rst +++ b/source/arche/toolkit.rst @@ -61,7 +61,7 @@ in one of the following ways: mybuf = ts.ResBufMaterialInv(capacity='buf_cap') You can read the `ResBuf API documentation -`_ for +`_ for more details on how to use the buffer. MatQuery [C++] diff --git a/source/kernel/style_guide.rst b/source/kernel/style_guide.rst index 55331dcd..cdcce593 100644 --- a/source/kernel/style_guide.rst +++ b/source/kernel/style_guide.rst @@ -15,8 +15,8 @@ The definitive documentation of any software is the source code itself. |cyclus| will relies on Doxygen for automation of rich documentation from appropriately formatted comments in the source code. Current Doxygen documentation can be found online for both `cyclus -`_ and `cycamore -`_. These pages will be updated nightly. +`_ and `cycamore +`_. These pages will be updated nightly. Documentation is a make target in the CMake build system. Documentation will automatically be built when you `make all`. You can build only the