mirror of
https://github.com/JHUAPL/kami.git
synced 2026-01-08 14:33:53 -05:00
Updates to documentation
This commit is contained in:
James P. Howard, II
@@ -10,7 +10,7 @@ cd kami
|
||||
conan install -if build .
|
||||
cmake -B build -DCMAKE_INSTALL_PREFIX=/tmp/kami -DBUILD_SHARED_LIBS:BOOL=FALSE
|
||||
cmake --build build
|
||||
ctest -C Debug
|
||||
cmake --build build --target test
|
||||
cmake --build build --target install
|
||||
```
|
||||
|
||||
|
||||
@@ -837,8 +837,7 @@ EXCLUDE_PATTERNS =
|
||||
# Note that the wildcards are matched against the file with absolute path, so to
|
||||
# exclude all test directories use the pattern */test/*
|
||||
|
||||
EXCLUDE_SYMBOLS = *_H \
|
||||
*_HPP
|
||||
EXCLUDE_SYMBOLS = KAMI_SEQUENTIAL_H
|
||||
|
||||
# The EXAMPLE_PATH tag can be used to specify one or more files or directories
|
||||
# that contain example code fragments that are included (see the \include
|
||||
@@ -1035,7 +1034,7 @@ IGNORE_PREFIX =
|
||||
# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
|
||||
# The default value is: YES.
|
||||
|
||||
GENERATE_HTML = YES
|
||||
GENERATE_HTML = NO
|
||||
|
||||
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
|
||||
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
|
||||
@@ -1579,7 +1578,7 @@ EXTRA_SEARCH_MAPPINGS =
|
||||
# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
|
||||
# The default value is: YES.
|
||||
|
||||
GENERATE_LATEX = YES
|
||||
GENERATE_LATEX = NO
|
||||
|
||||
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
|
||||
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
|
||||
@@ -1859,7 +1858,7 @@ MAN_LINKS = NO
|
||||
# captures the structure of the code including all documentation.
|
||||
# The default value is: NO.
|
||||
|
||||
GENERATE_XML = YES
|
||||
GENERATE_XML = NO
|
||||
|
||||
# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
|
||||
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
|
||||
|
||||
10
docs/conf.py
10
docs/conf.py
@@ -43,8 +43,8 @@ extensions = [
|
||||
'sphinx.ext.todo',
|
||||
'sphinx.ext.githubpages',
|
||||
'breathe',
|
||||
'exhale'
|
||||
]
|
||||
'exhale',
|
||||
'myst_parser']
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['_templates']
|
||||
@@ -105,7 +105,10 @@ release = version
|
||||
|
||||
# The suffix(es) of source filenames.
|
||||
# You can specify multiple suffix as a list of string:
|
||||
source_suffix = ['.rst', '.md']
|
||||
source_suffix = {
|
||||
'.rst': 'restructuredtext',
|
||||
'.md': 'markdown',
|
||||
}
|
||||
|
||||
# The master toctree document.
|
||||
master_doc = 'index'
|
||||
@@ -175,3 +178,4 @@ man_pages = [
|
||||
|
||||
# If true, show URL addresses after external links.
|
||||
# man_show_urls = False
|
||||
html_show_sphinx = False
|
||||
@@ -1,13 +1,24 @@
|
||||
Kami is Agent-Based Modeling in Modern C++
|
||||
==========================================
|
||||
Introduction
|
||||
============
|
||||
|
||||
|Build|
|
||||
|
||||
.. |Build| image:: https://github.com/k3jph/kami/actions/workflows/build.yml/badge.svg
|
||||
:target: https://github.com/k3jph/kami/actions/workflows/build.yml
|
||||
|
||||
Kami is agent-based modeling modern C++. The objectives in writing
|
||||
Kami are that it be lightweight, memory-efficient, and fast. It
|
||||
should be possible to develop a simple working model in under one
|
||||
hour of C++ development time. Accordingly, the platform is modeled
|
||||
extensively on the `Mesa
|
||||
<https://mesa.readthedocs.io/en/stable/overview.html>`_ library in
|
||||
Python, which itself was inspired by the `MASON
|
||||
<https://cs.gmu.edu/~eclab/projects/mason/>`_ library in Java.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:hidden:
|
||||
|
||||
about
|
||||
tutorial
|
||||
api/library_root
|
||||
license
|
||||
55
docs/license.rst
Normal file
55
docs/license.rst
Normal file
@@ -0,0 +1,55 @@
|
||||
License
|
||||
=======
|
||||
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer
|
||||
varius est at dignissim sodales. Nullam mauris velit, imperdiet sit
|
||||
amet neque nec, fringilla consectetur odio. In non erat varius,
|
||||
fringilla felis ut, sodales orci. Aliquam in turpis ultricies enim
|
||||
accumsan commodo. Duis at dolor quis dolor tristique suscipit eget
|
||||
at magna. Integer non eros vitae ipsum pellentesque pharetra ac sed
|
||||
sapien. Duis justo diam, bibendum ut ullamcorper ac, viverra sit
|
||||
amet risus. Curabitur blandit nisl ac posuere fermentum. Nulla
|
||||
convallis purus id velit pellentesque tempus. Pellentesque euismod
|
||||
augue non diam eleifend fermentum. Vestibulum ante ipsum primis in
|
||||
faucibus orci luctus et ultrices posuere cubilia curae;
|
||||
|
||||
Nulla iaculis orci neque, a rhoncus mi vestibulum vitae. Nam ut
|
||||
gravida magna. Nam vel dignissim lacus, id accumsan orci. Nullam
|
||||
cursus, dui nec finibus sagittis, nisi purus feugiat tortor, a
|
||||
aliquet quam metus eget enim. Cras et quam vitae nisi auctor varius
|
||||
eget vel lacus. In nibh orci, tempus eu odio et, euismod sodales
|
||||
nulla. Fusce luctus sit amet orci non interdum. Ut cursus volutpat
|
||||
feugiat. Nulla vitae ultricies augue. Donec orci dolor, convallis
|
||||
non tincidunt sit amet, consectetur ut nibh. Cras efficitur dictum
|
||||
eros, faucibus pretium odio rutrum at.
|
||||
|
||||
Phasellus lobortis ex nec felis iaculis tincidunt. Sed consequat
|
||||
sagittis urna at lobortis. Cras velit lorem, iaculis non felis et,
|
||||
sodales tempus erat. Mauris in ultricies metus. Ut bibendum nisl
|
||||
vel lectus consequat, vel pharetra est ultrices. Aliquam non lobortis
|
||||
massa. Mauris euismod turpis mi, eu tempor lectus molestie in. Donec
|
||||
auctor ante sed eros scelerisque volutpat. Morbi semper diam vitae
|
||||
ante feugiat, eu hendrerit felis aliquet. Sed placerat velit sit
|
||||
amet odio suscipit, a posuere lectus hendrerit. Nulla felis augue,
|
||||
cursus a tempus vitae, ullamcorper a ante. Aenean et elit mi.
|
||||
Suspendisse potenti. Mauris ac enim libero. Donec finibus id enim
|
||||
ut ullamcorper. Suspendisse eu imperdiet tellus.
|
||||
|
||||
Cras commodo vitae massa ac blandit. Donec ut mauris at lectus
|
||||
congue euismod in eleifend felis. Mauris id sapien orci. Cras ac
|
||||
enim et lectus fringilla vestibulum. Aliquam varius est mattis
|
||||
condimentum finibus. Nunc tristique justo nec nunc mollis, sit amet
|
||||
tempor neque iaculis. Class aptent taciti sociosqu ad litora torquent
|
||||
per conubia nostra, per inceptos himenaeos. Vestibulum ante ipsum
|
||||
primis in faucibus orci luctus et ultrices posuere cubilia curae;
|
||||
In commodo molestie porttitor. Duis blandit ligula a purus bibendum
|
||||
volutpat id in metus. Cras bibendum vel ex in accumsan. Phasellus
|
||||
congue ex eu scelerisque consectetur.
|
||||
|
||||
Maecenas pellentesque eget quam ac pellentesque. Morbi id tempus
|
||||
urna. In accumsan molestie neque nec imperdiet. Nam ultricies lacinia
|
||||
magna. Nullam dictum, massa ac fermentum rhoncus, lacus eros
|
||||
pellentesque ante, sed sollicitudin eros est in dui. Interdum et
|
||||
malesuada fames ac ante ipsum primis in faucibus. Integer porttitor,
|
||||
ante id bibendum volutpat, mi nunc mollis eros, sed auctor turpis
|
||||
mi et sem.
|
||||
55
docs/tutorial.rst
Normal file
55
docs/tutorial.rst
Normal file
@@ -0,0 +1,55 @@
|
||||
Tutorial
|
||||
========
|
||||
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer
|
||||
varius est at dignissim sodales. Nullam mauris velit, imperdiet sit
|
||||
amet neque nec, fringilla consectetur odio. In non erat varius,
|
||||
fringilla felis ut, sodales orci. Aliquam in turpis ultricies enim
|
||||
accumsan commodo. Duis at dolor quis dolor tristique suscipit eget
|
||||
at magna. Integer non eros vitae ipsum pellentesque pharetra ac sed
|
||||
sapien. Duis justo diam, bibendum ut ullamcorper ac, viverra sit
|
||||
amet risus. Curabitur blandit nisl ac posuere fermentum. Nulla
|
||||
convallis purus id velit pellentesque tempus. Pellentesque euismod
|
||||
augue non diam eleifend fermentum. Vestibulum ante ipsum primis in
|
||||
faucibus orci luctus et ultrices posuere cubilia curae;
|
||||
|
||||
Nulla iaculis orci neque, a rhoncus mi vestibulum vitae. Nam ut
|
||||
gravida magna. Nam vel dignissim lacus, id accumsan orci. Nullam
|
||||
cursus, dui nec finibus sagittis, nisi purus feugiat tortor, a
|
||||
aliquet quam metus eget enim. Cras et quam vitae nisi auctor varius
|
||||
eget vel lacus. In nibh orci, tempus eu odio et, euismod sodales
|
||||
nulla. Fusce luctus sit amet orci non interdum. Ut cursus volutpat
|
||||
feugiat. Nulla vitae ultricies augue. Donec orci dolor, convallis
|
||||
non tincidunt sit amet, consectetur ut nibh. Cras efficitur dictum
|
||||
eros, faucibus pretium odio rutrum at.
|
||||
|
||||
Phasellus lobortis ex nec felis iaculis tincidunt. Sed consequat
|
||||
sagittis urna at lobortis. Cras velit lorem, iaculis non felis et,
|
||||
sodales tempus erat. Mauris in ultricies metus. Ut bibendum nisl
|
||||
vel lectus consequat, vel pharetra est ultrices. Aliquam non lobortis
|
||||
massa. Mauris euismod turpis mi, eu tempor lectus molestie in. Donec
|
||||
auctor ante sed eros scelerisque volutpat. Morbi semper diam vitae
|
||||
ante feugiat, eu hendrerit felis aliquet. Sed placerat velit sit
|
||||
amet odio suscipit, a posuere lectus hendrerit. Nulla felis augue,
|
||||
cursus a tempus vitae, ullamcorper a ante. Aenean et elit mi.
|
||||
Suspendisse potenti. Mauris ac enim libero. Donec finibus id enim
|
||||
ut ullamcorper. Suspendisse eu imperdiet tellus.
|
||||
|
||||
Cras commodo vitae massa ac blandit. Donec ut mauris at lectus
|
||||
congue euismod in eleifend felis. Mauris id sapien orci. Cras ac
|
||||
enim et lectus fringilla vestibulum. Aliquam varius est mattis
|
||||
condimentum finibus. Nunc tristique justo nec nunc mollis, sit amet
|
||||
tempor neque iaculis. Class aptent taciti sociosqu ad litora torquent
|
||||
per conubia nostra, per inceptos himenaeos. Vestibulum ante ipsum
|
||||
primis in faucibus orci luctus et ultrices posuere cubilia curae;
|
||||
In commodo molestie porttitor. Duis blandit ligula a purus bibendum
|
||||
volutpat id in metus. Cras bibendum vel ex in accumsan. Phasellus
|
||||
congue ex eu scelerisque consectetur.
|
||||
|
||||
Maecenas pellentesque eget quam ac pellentesque. Morbi id tempus
|
||||
urna. In accumsan molestie neque nec imperdiet. Nam ultricies lacinia
|
||||
magna. Nullam dictum, massa ac fermentum rhoncus, lacus eros
|
||||
pellentesque ante, sed sollicitudin eros est in dui. Interdum et
|
||||
malesuada fames ac ante ipsum primis in faucibus. Integer porttitor,
|
||||
ante id bibendum volutpat, mi nunc mollis eros, sed auctor turpis
|
||||
mi et sem.
|
||||
Reference in New Issue
Block a user