Xccels Read the Docs - Example document site
========================================================================

`xccels_ReadtheDocs <https://github.com/cold-young/xccels_ReadtheDocs>`_ is an example of Read the docs.


Github repository: https://github.com/cold-young/xccels_ReadtheDocs

Main Features
--------------

- User Guide
- Alogorithms
- Performance

.. toctree::
   :maxdepth: 1
   :caption: User Guide

   guide/install
   guide/example
   
.. toctree::
  :maxdepth: 1
  :caption: This Algorithms 

  modules/A_alogrithm

Citing This
------------------------
To cite this project in publications:

.. code-block:: bibtex

  @article{xccels_ReadtheDocs,
    author  = {ABC Kim and cold-young},
    title   = {xccels_ReadtheDocs: An Example for Xccels Workshop},
    journal = {ABC Journal},
    year    = {2024},
    volume  = {12},
    number  = {0},
    pages   = {8},
    url     = {https://github.com/cold-young}
  }

Contributing
---------------------------
Thanks for writing this library and inspiring feedback on GitHub!

Special thanks to all the contributors:

.. image:: https://contrib.rocks/image?repo=cold-young/xccels_ReadtheDocs
   :target: https://github.com/cold-young/xccels_ReadtheDocs/graphs/contributors


Indices and tables
-------------------

* :ref:`genindex`
* :ref:`search`
* :ref:`modindex`