Skip to content

Commit

Permalink
Merge branch 'add-sphinx' of https://github.com/bigladder/atheneum in…
Browse files Browse the repository at this point in the history
…to add-sphinx
  • Loading branch information
tanaya-mankad committed Mar 26, 2024
2 parents d85a22c + 2d91528 commit c567304
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 5 deletions.
9 changes: 6 additions & 3 deletions docs/sphinx-source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,19 @@
Welcome to atheneum documentation!
=============================================

Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been
the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of
type and scrambled it to make a type specimen book. From `<https://www.lipsum.com/>`_

.. toctree::
:maxdepth: 2
:caption: Contents:

Docs
====

.. doxygennamespace:: atheneum

.. doxygenclass:: Atheneum
.. doxygennamespace:: Atheneum
:project: atheneum


Indices and tables
Expand Down
4 changes: 2 additions & 2 deletions include/atheneum/atheneum.h
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ namespace Atheneum

class AtheneumPrivate;

/// @class Atheneum::Atheneum atheneum.h
/// @brief Public interface file for for the Atheneum Pimpl idiom
/// @class Atheneum atheneum.h
/// @brief Public interface for for the Atheneum Pimpl idiom

class Atheneum
{
Expand Down

0 comments on commit c567304

Please sign in to comment.