File tree 6 files changed +13
-13
lines changed
6 files changed +13
-13
lines changed Original file line number Diff line number Diff line change @@ -9,13 +9,13 @@ RUN make gh-preview
9
9
10
10
WORKDIR /cyclus/build
11
11
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/
14
14
15
15
WORKDIR /cycamore/build
16
16
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/
19
19
20
20
21
21
FROM scratch
Original file line number Diff line number Diff line change @@ -24,7 +24,7 @@ used to automate the generation of code for the following functions:
24
24
void InitFrom(cyclus::Agent*);
25
25
26
26
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
28
28
listed above VERY CAREFULLY. There are also a few other functions related to
29
29
initialization that are important to understand well:
30
30
Original file line number Diff line number Diff line change @@ -278,7 +278,7 @@ The parameters that can be set (or not) for each source/sink are:
278
278
* ``lifetime(int) ``: The number of time steps the source/sink is deployed
279
279
until automatic decommissioning. Default is infinite (never decommissioned).
280
280
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 >`_.
282
282
Querying simulation results can be accomplished by getting a reference to the
283
283
in-memory database generated. Not all data that is present in normal
284
284
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:
307
307
EXPECT_DOUBLE_EQ(9.5, mq.mass(922380000));
308
308
309
309
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
311
311
`query results
312
- <http://fuelcycle.org/ cyclus/api /classcyclus_1_1QueryResult.html> `_ for more
312
+ </ cyclus/classcyclus_1_1QueryResult.html> `_ for more
313
313
details.
314
314
315
315
Debugging
Original file line number Diff line number Diff line change @@ -61,7 +61,7 @@ in one of the following ways:
61
61
mybuf = ts.ResBufMaterialInv(capacity = ' buf_cap' )
62
62
63
63
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
65
65
more details on how to use the buffer.
66
66
67
67
MatQuery [C++]
Original file line number Diff line number Diff line change @@ -8,8 +8,8 @@ <h3>{{ _('Useful Pages') }}</h3>
8
8
< li > < a href ="/arche/index.html "> Archetype Developer Guide</ a > </ li >
9
9
< li > < a href ="/arche/tutorial_cpp/index.html "> Archetype Developer C++ Tutorial</ a > </ li >
10
10
< 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 >
13
13
< li > < a href ="/basics/glossary.html "> Glossary</ a > </ li >
14
14
< li > < a href ="
mailto:[email protected] ?subject=Subscribe&body=Send this message to subscribe to the list "
> Join
</ a > the
15
15
< a href ="https://groups.google.com/forum/#!forum/cyclus-users " target ="_blank "> < span style ="font-variant:small-caps "> Cyclus</ span > Users</ a > mailing list.
Original file line number Diff line number Diff line change @@ -15,8 +15,8 @@ The definitive documentation of any software is the source code itself.
15
15
|cyclus | will relies on Doxygen for automation of rich documentation from
16
16
appropriately formatted comments in the source code. Current Doxygen
17
17
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.
20
20
21
21
Documentation is a make target in the CMake build system. Documentation
22
22
will automatically be built when you `make all `. You can build only the
You can’t perform that action at this time.
0 commit comments