Skip to content

Commit

Permalink
change location of docs from /cyclus/api to /cyclus
Browse files Browse the repository at this point in the history
  • Loading branch information
bennibbelink committed Oct 8, 2024
1 parent 5f4fb81 commit d8f7e94
Show file tree
Hide file tree
Showing 6 changed files with 13 additions and 13 deletions.
8 changes: 4 additions & 4 deletions docker/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@ RUN make gh-preview

WORKDIR /cyclus/build
RUN make cyclusdoc && \
mkdir -p /cyclus.github.com/${BUILDDIR}/cyclus/api && \
cp -r doc/html/* /cyclus.github.com/${BUILDDIR}/cyclus/api/
mkdir -p /cyclus.github.com/${BUILDDIR}/cyclus && \
cp -r doc/html/* /cyclus.github.com/${BUILDDIR}/cyclus/

WORKDIR /cycamore/build
RUN make cycamoredoc && \
mkdir -p /cyclus.github.com/${BUILDDIR}/cycamore/api && \
cp -r doc/html/* /cyclus.github.com/${BUILDDIR}/cycamore/api/
mkdir -p /cyclus.github.com/${BUILDDIR}/cycamore && \
cp -r doc/html/* /cyclus.github.com/${BUILDDIR}/cycamore/


FROM scratch
Expand Down
2 changes: 1 addition & 1 deletion source/arche/sim_init.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
<http://fuelcycle.org/cyclus/api/classcyclus_1_1Agent.html>`_ for the functions
<http://fuelcycle.org/cyclus/classcyclus_1_1Agent.html>`_ for the functions
listed above VERY CAREFULLY. There are also a few other functions related to
initialization that are important to understand well:

Expand Down
6 changes: 3 additions & 3 deletions source/arche/testing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <http://fuelcycle.org/cyclus/api/classcyclus_1_1MockSim.html>`_.
For more details, you can read the `MockSim API docs <http://fuelcycle.org/cyclus/classcyclus_1_1MockSim.html>`_.
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
Expand Down Expand Up @@ -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
<http://fuelcycle.org/cyclus/api/classcyclus_1_1QueryableBackend.html>`_ and
<http://fuelcycle.org/cyclus/classcyclus_1_1QueryableBackend.html>`_ and
`query results
<http://fuelcycle.org/cyclus/api/classcyclus_1_1QueryResult.html>`_ for more
<http://fuelcycle.org/cyclus/classcyclus_1_1QueryResult.html>`_ for more
details.

Debugging
Expand Down
2 changes: 1 addition & 1 deletion source/arche/toolkit.rst
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ in one of the following ways:
mybuf = ts.ResBufMaterialInv(capacity='buf_cap')
You can read the `ResBuf API documentation
<http://fuelcycle.org/cyclus/api/classcyclus_1_1toolkit_1_1ResBuf.html>`_ for
<http://fuelcycle.org/cyclus/classcyclus_1_1toolkit_1_1ResBuf.html>`_ for
more details on how to use the buffer.

MatQuery [C++]
Expand Down
4 changes: 2 additions & 2 deletions source/atemplates/sidebar.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ <h3>{{ _('Useful Pages') }}</h3>
<li><a href="/arche/index.html">Archetype Developer Guide</a></li>
<li><a href="/arche/tutorial_cpp/index.html">Archetype Developer C++ Tutorial</a></li>
<li><a href="/arche/tutorial_py/index.html">Archetype Developer Python Tutorial</a></li>
<li><a href="/cyclus/api/">Cyclus API Documentation</a></li>
<li><a href="/cycamore/api/">Cycamore API Documentation</a></li>
<li><a href="/cyclus/">Cyclus API Documentation</a></li>
<li><a href="/cycamore/">Cycamore API Documentation</a></li>
<li><a href="/basics/glossary.html">Glossary</a></li>
<li><a href="mailto:[email protected]?subject=Subscribe&body=Send this message to subscribe to the list">Join</a> the
<a href="https://groups.google.com/forum/#!forum/cyclus-users" target="_blank"><span style="font-variant:small-caps">Cyclus</span> Users</a> mailing list.
Expand Down
4 changes: 2 additions & 2 deletions source/kernel/style_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
<http://fuelcycle.org/cyclus/api/>`_ and `cycamore
<http://fuelcycle.org/cycamore/api/>`_. These pages will be updated nightly.
<http://fuelcycle.org/cyclus/>`_ and `cycamore
<http://fuelcycle.org/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
Expand Down

0 comments on commit d8f7e94

Please sign in to comment.