.. Intel® SHMEM documentation master file, created by
   sphinx-quickstart on Thu Mar 10 16:24:14 2022.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

***********************
Intel® SHMEM
***********************

.. toctree::
   :maxdepth: 3
   :caption: Introduction / Essentials

   intro
   programming_model
   memory_model
   execution_model
   supported_features

.. =================================
.. Language Bindings and Conformance
.. =================================

.. toctree::
   :maxdepth: 3
   :caption: Library Constants and Env Vars

   library_constants

.. _ishmem_api:

.. toctree::
   :maxdepth: 3
   :caption: Intel® SHMEM API

   library_setup_exit_query
   thread_support
   memory_management
   teams
   rma
   atomics
   signaling
   collectives
   pt2pt_sync
   memory_ordering
   utility

.. ---------------
.. Team Management
.. ---------------

.. ------------------------
.. Communication Management
.. ------------------------

.. --------------------
.. Signaling Operations
.. --------------------

.. -------------------
.. Distributed Locking
.. -------------------

.. =============================
.. OpenSHMEM Profiling Interface
.. =============================


.. toctree::
   :maxdepth: 3
   :caption: Build, Write, and Run Programs

   building_ishmem
   writing_programs
   compiling_and_running_programs
   ishmem_in_devcloud

.. toctree::
   :maxdepth: 3
   :caption: Acknowledgements / Copyright

   acknowledgements

.. ==================
.. Undefined Behavior
.. ==================

.. ==============================================
.. Interoperability with other Programming Models
.. ==============================================

.. ====================
.. History of OpenSHMEM
.. ====================
.. 
.. ==============
.. Deprecated API
.. ==============

.. ========================
.. Changes to this Document
.. ========================

.. ========
.. Glossary
.. ========

.. =====
.. Index
.. =====