Skip to content

Commit

Permalink
still working
Browse files Browse the repository at this point in the history
  • Loading branch information
Ryan Danehy committed Nov 10, 2023
1 parent f5fa5ba commit 6f0c799
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 11 deletions.
23 changes: 23 additions & 0 deletions docs/doxygen/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@

Source Documentation
====================

Primal is a component of Axom that provides efficient and general purpose
algorithms and data structures for computational geometry. Primal provides:

- Classes to represent geometric primitives such as Point and Ray
- Functions operating on Primal's classes to implement geometric operators,
including distance and intersection

This tutorial contains a collection of brief examples demonstrating
Primal primitives and operators. The examples instantiate geometric primitives
as needed and demonstrate geometric operators. These examples also show
representative overloads of each of the Primal operators (see the
`API documentation <../../../../doxygen/html/primaltop.html>`_
for more details).


API Documentation
-----------------

Doxygen generated API documentation can be found here: `API documentation <./html/index.html>`_
14 changes: 3 additions & 11 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ User guides and source code documentation are always linked on this site.
:align: center

* - Functions
- `Source Documentation <doxygen/html/functions.html>`_
- `Source <doxygen/html/functions.html>`_
* - Namespaces
- `Source Documentation <doxygen/html/namespaces.html>`_

Expand Down Expand Up @@ -134,7 +134,7 @@ Passing tests
9/9 Test #9: logger_test ...................... Passed 0.03 sec
Important Notes
~~~~~~~~~~~~~~~
---------------

You can find default Cmake Configurations in the CMakePresets.json file,
which allows for easy switching between different CMake Configs. To
Expand Down Expand Up @@ -187,15 +187,6 @@ the `LICENSE <LICENSE>`__ and `NOTICE <NOTICE>`__ files for details. All
new contributions to ReSolve must be made under the smae licensing
terms.

.. toctree::
:maxdepth: 3
:hidden:
:titlesonly:
:caption: Software Documentation

sphinx/doxygen/html/index
sphinx/doxygen/html/classReSolve_1_1LinSolver
sphinx/doxygen/html/classReSolve_1_1GramSchmidt

.. toctree::
:maxdepth: 3
Expand All @@ -204,3 +195,4 @@ terms.

sphinx/coding_guide/index
sphinx/licenses
doxygen/index
22 changes: 22 additions & 0 deletions docs/sphinx/_build/_static/theme_overrides.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
/* override table width restrictions */
@media screen and (min-width: 767px) {

.wy-table-responsive table td {
/* !important prevents the common CSS stylesheets from overriding
this as on RTD they are loaded after this stylesheet */
white-space: normal !important;
}

.wy-table-responsive {
overflow: visible !important;
}
}

a img.logo {
transform: scale(.75)
}

/* Sidebar header (and topbar for mobile) */
.wy-side-nav-search, .wy-nav-top {
background: #343131;
}

0 comments on commit 6f0c799

Please sign in to comment.