Skip to content

Commit 32b9979

Browse files
authored
Merge pull request #391 from bennibbelink/api-docs-path
Change API docs location
2 parents 5f4fb81 + 5836880 commit 32b9979

File tree

6 files changed

+13
-13
lines changed

6 files changed

+13
-13
lines changed

docker/Dockerfile

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ RUN make gh-preview
99

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

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

2020

2121
FROM scratch

source/arche/sim_init.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ used to automate the generation of code for the following functions:
2424
void InitFrom(cyclus::Agent*);
2525

2626
When the preprocessor isn't sufficient, read the `API documents
27-
<http://fuelcycle.org/cyclus/api/classcyclus_1_1Agent.html>`_ for the functions
27+
</cyclus/classcyclus_1_1Agent.html>`_ for the functions
2828
listed above VERY CAREFULLY. There are also a few other functions related to
2929
initialization that are important to understand well:
3030

source/arche/testing.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -278,7 +278,7 @@ The parameters that can be set (or not) for each source/sink are:
278278
* ``lifetime(int)``: The number of time steps the source/sink is deployed
279279
until automatic decommissioning. Default is infinite (never decommissioned).
280280

281-
For more details, you can read the `MockSim API docs <http://fuelcycle.org/cyclus/api/classcyclus_1_1MockSim.html>`_.
281+
For more details, you can read the `MockSim API docs </cyclus/classcyclus_1_1MockSim.html>`_.
282282
Querying simulation results can be accomplished by getting a reference to the
283283
in-memory database generated. Not all data that is present in normal
284284
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:
307307
EXPECT_DOUBLE_EQ(9.5, mq.mass(922380000));
308308

309309
You can read API documentation for the `queryable database
310-
<http://fuelcycle.org/cyclus/api/classcyclus_1_1QueryableBackend.html>`_ and
310+
</cyclus/classcyclus_1_1QueryableBackend.html>`_ and
311311
`query results
312-
<http://fuelcycle.org/cyclus/api/classcyclus_1_1QueryResult.html>`_ for more
312+
</cyclus/classcyclus_1_1QueryResult.html>`_ for more
313313
details.
314314

315315
Debugging

source/arche/toolkit.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ in one of the following ways:
6161
mybuf = ts.ResBufMaterialInv(capacity='buf_cap')
6262
6363
You can read the `ResBuf API documentation
64-
<http://fuelcycle.org/cyclus/api/classcyclus_1_1toolkit_1_1ResBuf.html>`_ for
64+
</cyclus/classcyclus_1_1toolkit_1_1ResBuf.html>`_ for
6565
more details on how to use the buffer.
6666

6767
MatQuery [C++]

source/atemplates/sidebar.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ <h3>{{ _('Useful Pages') }}</h3>
88
<li><a href="/arche/index.html">Archetype Developer Guide</a></li>
99
<li><a href="/arche/tutorial_cpp/index.html">Archetype Developer C++ Tutorial</a></li>
1010
<li><a href="/arche/tutorial_py/index.html">Archetype Developer Python Tutorial</a></li>
11-
<li><a href="/cyclus/api/">Cyclus API Documentation</a></li>
12-
<li><a href="/cycamore/api/">Cycamore API Documentation</a></li>
11+
<li><a href="/cyclus/">Cyclus API Documentation</a></li>
12+
<li><a href="/cycamore/">Cycamore API Documentation</a></li>
1313
<li><a href="/basics/glossary.html">Glossary</a></li>
1414
<li><a href="mailto:[email protected]?subject=Subscribe&body=Send this message to subscribe to the list">Join</a> the
1515
<a href="https://groups.google.com/forum/#!forum/cyclus-users" target="_blank"><span style="font-variant:small-caps">Cyclus</span> Users</a> mailing list.

source/kernel/style_guide.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ The definitive documentation of any software is the source code itself.
1515
|cyclus| will relies on Doxygen for automation of rich documentation from
1616
appropriately formatted comments in the source code. Current Doxygen
1717
documentation can be found online for both `cyclus
18-
<http://fuelcycle.org/cyclus/api/>`_ and `cycamore
19-
<http://fuelcycle.org/cycamore/api/>`_. These pages will be updated nightly.
18+
</cyclus/>`_ and `cycamore
19+
</cycamore/>`_. These pages will be updated nightly.
2020

2121
Documentation is a make target in the CMake build system. Documentation
2222
will automatically be built when you `make all`. You can build only the

0 commit comments

Comments
 (0)