sol2/docs/source/index.rst

.. sol documentation master file, created by
   sphinx-quickstart on Mon Feb 29 21:49:51 2016.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

.. image:: media/sol.png
	:target: https://github.com/ThePhD/sol2
	:alt: sol repository
	:align: center

sol |version|
=============
*a fast, simple C++ and Lua Binding*


When you need to hit the ground running with Lua and C++, `sol`_ is the go-to framework for high-performance binding with an easy to use API.

get going:
----------

.. toctree::
	:maxdepth: 1
	:name: mastertoc
	
	tutorial/all-the-things
	tutorial/tutorial-top
	errors
	compilation
	features
	functions
	usertypes
	containers
	threading
	traits
	api/api-top
	mentions
	benchmarks
	performance
	safety
	exceptions
	rtti
	codecvt
	build
	licenses
	origin


"I need feature X, maybe you have it?"
--------------------------------------
Take a look at the :doc:`Features<features>` page: it links to much of the API. You can also just straight up browse the :doc:`api<api/api-top>` or ease in with the :doc:`tutorials<tutorial/tutorial-top>`. To know more about the implementation for usertypes, see :doc:`here<usertypes>` To know how function arguments are handled, see :ref:`this note<function-argument-handling>`. Don't see a feature you want? Send inquiries for support for a particular abstraction to the `issues`_ tracker.


the basics:
-----------

.. note::
	The code below *and* more examples can be found in the `examples directory`_


.. literalinclude:: ../../examples/docs/simple_functions.cpp
	:name: simple-functions-example
	:linenos:

.. literalinclude:: ../../examples/docs/simple_structs.cpp
	:name: simple-structs-example
	:linenos:	


helping out
-----------

You can support sol2 development by `donating here`_. This is a time-consuming effort, so individuals who donate get to:

- steer the direction and time spent on sol
- get a role on the Discord server
- get their name put up in the CONTRIBUTORS list
- put something of their choice on sol2's README or the documentation's front page

You can also help out the library by submitting pull requests to fix anything or add anything you think would be helpful! This includes making small, useful examples of something you haven't seen, or fixing typos and bad code in the documentation.

Finally, `come join in Discord`_!

Indices and tables
==================

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

.. _Sol: https://github.com/ThePhD/sol2
.. _issues: https://github.com/ThePhD/sol2/issues
.. _examples directory: https://github.com/ThePhD/sol2/tree/develop/examples
.. _donating here: https://www.paypal.me/LMeneide
.. _come join in Discord: https://discord.gg/buxkYNT
begin migrating benchmarks and preparing documentation for sol3 2018-05-17 14:31:28 +08:00			`.. sol documentation master file, created by`
The docs are here. 2016-03-12 06:47:15 +08:00			`sphinx-quickstart on Mon Feb 29 21:49:51 2016.`
			`You can adapt this file completely to your liking, but it should at least`
			contain the root `toctree` directive.

update docs and benchmarks to include images directly to cut down on doc build warnings add coroutine tests for new xmove copy and move constructors cry tears because Lua does not kill the variables on the thread before killing the thread 2017-09-13 07:15:23 +08:00			`.. image:: media/sol.png`
[ci skip] heavy documentation changes 2016-04-26 03:58:13 +08:00			`:target: https://github.com/ThePhD/sol2`
begin migrating benchmarks and preparing documentation for sol3 2018-05-17 14:31:28 +08:00			`:alt: sol repository`
			`:align: center`
[ci skip] heavy documentation changes 2016-04-26 03:58:13 +08:00
begin migrating benchmarks and preparing documentation for sol3 2018-05-17 14:31:28 +08:00			`sol \|version\|`
Prepare for release. 2016-11-06 11:17:31 +08:00			`=============`
this mega commit prepares to fix all of the issues listed in the repository for the past 3 weeks 2017-08-06 07:20:28 +08:00			`a fast, simple C++ and Lua Binding`

The docs are here. 2016-03-12 06:47:15 +08:00
begin migrating benchmarks and preparing documentation for sol3 2018-05-17 14:31:28 +08:00			When you need to hit the ground running with Lua and C++, `sol`_ is the go-to framework for high-performance binding with an easy to use API.
fixing up da docs 2016-03-12 10:45:41 +08:00
			`get going:`
			`----------`
The docs are here. 2016-03-12 06:47:15 +08:00
			`.. toctree::`
[ci skip] relevant changes to docs 2016-08-25 00:22:51 +08:00			`:maxdepth: 1`
Documentation update, `get_or` for proxies, and other goodies. 2016-04-09 12:55:12 +08:00			`:name: mastertoc`
The docs are here. 2016-03-12 06:47:15 +08:00
Shiny quick 'n' dirty tutorial -- variadic_args now is iterable -- fixed bug with transparent args in overload resolution -- added `load` functions 2016-04-24 05:07:51 +08:00			`tutorial/all-the-things`
loadfilex doesn't exist... nice. 2016-04-24 05:16:56 +08:00			`tutorial/tutorial-top`
Heavily improve documentation and add new container functions. 2016-11-06 08:08:07 +08:00			`errors`
Add registry constructors to tug things right out of the registry, and add a main_thread getter to aid in Joynet dev 2016-12-10 13:25:25 +08:00			`compilation`
Documentation update, `get_or` for proxies, and other goodies. 2016-04-09 12:55:12 +08:00			`features`
prepare for container_traits to be a thing update large parts of the documentation and add a new section to streamline information about functions 2017-07-01 23:02:15 +08:00			`functions`
Mmn. Always making lots and lots of small changes. 2016-10-24 07:17:33 +08:00			`usertypes`
this mega commit prepares to fix all of the issues listed in the repository for the past 3 weeks 2017-08-06 07:20:28 +08:00			`containers`
[ci skip] don't forget to add threading 2017-04-03 04:28:57 +08:00			`threading`
Heavily improve documentation and add new container functions. 2016-11-06 08:08:07 +08:00			`traits`
[ci-skip] heavy documentation updates. Closes #89 2016-05-13 23:50:06 +08:00			`api/api-top`
[ci-skip] update feature table and be good at stuff 2016-08-12 23:06:14 +08:00			`mentions`
Documentation update, `get_or` for proxies, and other goodies. 2016-04-09 12:55:12 +08:00			`benchmarks`
[ci skip] improve documentation 2016-08-17 03:19:51 +08:00			`performance`
Documentation update, `get_or` for proxies, and other goodies. 2016-04-09 12:55:12 +08:00			`safety`
			`exceptions`
			`rtti`
Turns out C++ sucks when all implementers don't do things equally as fast. WHO KNEW? 2016-08-13 01:08:59 +08:00			`codecvt`
fix up variables tutorial 2018-11-10 06:36:27 +08:00			`build`
Documentation update, `get_or` for proxies, and other goodies. 2016-04-09 12:55:12 +08:00			`licenses`
			`origin`
The docs are here. 2016-03-12 06:47:15 +08:00
fixing up da docs 2016-03-12 10:45:41 +08:00
The docs are here. 2016-03-12 06:47:15 +08:00			`"I need feature X, maybe you have it?"`
			`--------------------------------------`
Mmn. Always making lots and lots of small changes. 2016-10-24 07:17:33 +08:00			Take a look at the :doc:`Features<features>` page: it links to much of the API. You can also just straight up browse the :doc:`api<api/api-top>` or ease in with the :doc:`tutorials<tutorial/tutorial-top>`. To know more about the implementation for usertypes, see :doc:`here<usertypes>` To know how function arguments are handled, see :ref:`this note<function-argument-handling>`. Don't see a feature you want? Send inquiries for support for a particular abstraction to the `issues`_ tracker.
The docs are here. 2016-03-12 06:47:15 +08:00

fixing up da docs 2016-03-12 10:45:41 +08:00			`the basics:`
The docs are here. 2016-03-12 06:47:15 +08:00			`-----------`

			`.. note::`
Update documentation, refactor examples out of docs, fix warning about static entry path Still need help refactoring out more code from docs... 2018-02-25 06:19:16 +08:00			The code below and more examples can be found in the `examples directory`_
The docs are here. 2016-03-12 06:47:15 +08:00
Indentation fixes 2016-04-11 14:15:06 +08:00
Update documentation, refactor examples out of docs, fix warning about static entry path Still need help refactoring out more code from docs... 2018-02-25 06:19:16 +08:00			`.. literalinclude:: ../../examples/docs/simple_functions.cpp`
			`:name: simple-functions-example`
Indentation fixes 2016-04-11 14:15:06 +08:00			`:linenos:`
The docs are here. 2016-03-12 06:47:15 +08:00
Update documentation, refactor examples out of docs, fix warning about static entry path Still need help refactoring out more code from docs... 2018-02-25 06:19:16 +08:00			`.. literalinclude:: ../../examples/docs/simple_structs.cpp`
			`:name: simple-structs-example`
			`:linenos:`
The docs are here. 2016-03-12 06:47:15 +08:00

add coroutine guard update version add donation link 2017-11-22 03:33:27 +08:00			`helping out`
			`-----------`

update documentation with additional information about resolve and overload (fixes #664 and fixes #665) add new shared_ptr differentiation mechanism that persists between DLLs (fixes #661) change valid Lua version to handle Lua 5.4.0-work1 (fixes #649) remove upper limit on MSVC version: they're not fixing it anytime soon (fixes #655) add integer value for definition (fixes #651) 2018-06-16 01:19:09 +08:00			You can support sol2 development by `donating here`_. This is a time-consuming effort, so individuals who donate get to:
add coroutine guard update version add donation link 2017-11-22 03:33:27 +08:00
update documentation with additional information about resolve and overload (fixes #664 and fixes #665) add new shared_ptr differentiation mechanism that persists between DLLs (fixes #661) change valid Lua version to handle Lua 5.4.0-work1 (fixes #649) remove upper limit on MSVC version: they're not fixing it anytime soon (fixes #655) add integer value for definition (fixes #651) 2018-06-16 01:19:09 +08:00			`- steer the direction and time spent on sol`
			`- get a role on the Discord server`
			`- get their name put up in the CONTRIBUTORS list`
			`- put something of their choice on sol2's README or the documentation's front page`
add coroutine guard update version add donation link 2017-11-22 03:33:27 +08:00
update documentation with additional information about resolve and overload (fixes #664 and fixes #665) add new shared_ptr differentiation mechanism that persists between DLLs (fixes #661) change valid Lua version to handle Lua 5.4.0-work1 (fixes #649) remove upper limit on MSVC version: they're not fixing it anytime soon (fixes #655) add integer value for definition (fixes #651) 2018-06-16 01:19:09 +08:00			`You can also help out the library by submitting pull requests to fix anything or add anything you think would be helpful! This includes making small, useful examples of something you haven't seen, or fixing typos and bad code in the documentation.`
add coroutine guard update version add donation link 2017-11-22 03:33:27 +08:00
update documentation with additional information about resolve and overload (fixes #664 and fixes #665) add new shared_ptr differentiation mechanism that persists between DLLs (fixes #661) change valid Lua version to handle Lua 5.4.0-work1 (fixes #649) remove upper limit on MSVC version: they're not fixing it anytime soon (fixes #655) add integer value for definition (fixes #651) 2018-06-16 01:19:09 +08:00			Finally, `come join in Discord`_!
The docs are here. 2016-03-12 06:47:15 +08:00
			`Indices and tables`
			`==================`

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

fixing up da docs 2016-03-12 10:45:41 +08:00			`.. _Sol: https://github.com/ThePhD/sol2`
			`.. _issues: https://github.com/ThePhD/sol2/issues`
add coroutine guard update version add donation link 2017-11-22 03:33:27 +08:00			`.. _examples directory: https://github.com/ThePhD/sol2/tree/develop/examples`
update documentation with additional information about resolve and overload (fixes #664 and fixes #665) add new shared_ptr differentiation mechanism that persists between DLLs (fixes #661) change valid Lua version to handle Lua 5.4.0-work1 (fixes #649) remove upper limit on MSVC version: they're not fixing it anytime soon (fixes #655) add integer value for definition (fixes #651) 2018-06-16 01:19:09 +08:00			`.. _donating here: https://www.paypal.me/LMeneide`
			`.. _come join in Discord: https://discord.gg/buxkYNT`