StarMirror/sol2
1
0
Fork 0
mirror of https://github.com/ThePhD/sol2.git synced 2024-03-22 13:10:44 +08:00
Code Issues Projects Releases Wiki Activity
890cdd38b4
sol2/docs/source/index.rst

140 lines
3.6 KiB
ReStructuredText
Raw Normal View History

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
filters -> policies shill out on the docs prepare to update all docs fix #809
2019-05-21 15:57:10 +08:00
connect
--------
Come to the Github Issues or the Discord! We've got a friendly community, and they can help you out or you can come just to talk about the things you are working on!
|ds| |gh|
support
-------
You can support the project and other related endeavors in various ways.
update funding links and documentation pic layout for GitHub Sponrs
2019-07-06 02:42:24 +08:00
|gs| |pa| |kf| |lp| |pp|
filters -> policies shill out on the docs prepare to update all docs fix #809
2019-05-21 15:57:10 +08:00
update funding links and documentation pic layout for GitHub Sponrs
2019-07-06 02:42:24 +08:00
GitHub Sponsors is matching all sponsorships 100% and they also do not charge fees on either end of the transaction as well until sometime in June 2020. Still, you can support sol3 development by using any of the above. This is a time-consuming effort, so individuals who donate get to:
filters -> policies shill out on the docs prepare to update all docs fix #809
2019-05-21 15:57:10 +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 sol3's README or the documentation's front page
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::
filters -> policies shill out on the docs prepare to update all docs fix #809
2019-05-21 15:57:10 +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
fix up CMake files once more, and hopefully prepare for a new test coverage paradigm notably, test normal + single + generated + Lua 5.3.5 only once, then only run the runtime_test and compile_test for normal for all other permutations to help increase text matrix throughput
2018-12-27 15:17:25 +08:00
.. literalinclude:: ../../examples/source/docs/simple_functions.cpp
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
: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
fix up CMake files once more, and hopefully prepare for a new test coverage paradigm notably, test normal + single + generated + Lua 5.3.5 only once, then only run the runtime_test and compile_test for normal for all other permutations to help increase text matrix throughput
2018-12-27 15:17:25 +08:00
.. literalinclude:: ../../examples/source/docs/simple_structs.cpp
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
:name: simple-structs-example
filters -> policies shill out on the docs prepare to update all docs fix #809
2019-05-21 15:57:10 +08:00
:linenos:
add coroutine guard update version add donation link
2017-11-22 03:33:27 +08:00
The docs are here.
2016-03-12 06:47:15 +08:00
genindex is weird
2019-05-25 04:39:55 +08:00
Search
======
The docs are here.
2016-03-12 06:47:15 +08:00
* :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
filters -> policies shill out on the docs prepare to update all docs fix #809
2019-05-21 15:57:10 +08:00
.. |pa| image:: media/become_a_patron_button.png
:height: 50
Fix up all the funding/donation links. Again!
2020-05-03 21:50:30 +08:00
:target: https://www.patreon.com/soasis
filters -> policies shill out on the docs prepare to update all docs fix #809
2019-05-21 15:57:10 +08:00
:alt: sol3 Patreon
:align: middle
.. |kf| image:: media/Ko-fi_Blue.png
:height: 50
Fix up all the funding/donation links. Again!
2020-05-03 21:50:30 +08:00
:target: https://ko-fi.com/soasis
filters -> policies shill out on the docs prepare to update all docs fix #809
2019-05-21 15:57:10 +08:00
:alt: sol3 ko-fi
:align: middle
.. |lp| image:: media/liberapay_logo.png
:height: 50
Fix up all the funding/donation links. Again!
2020-05-03 21:50:30 +08:00
:target: https://liberapay.com/Soasis
filters -> policies shill out on the docs prepare to update all docs fix #809
2019-05-21 15:57:10 +08:00
:alt: sol3 ko-fi
:align: middle
.. |pp| image:: media/pp_cc_mark_111x69.jpg
:height: 50
Fix up all the funding/donation links. Again!
2020-05-03 21:50:30 +08:00
:target: https://www.paypal.me/Soasis
filters -> policies shill out on the docs prepare to update all docs fix #809
2019-05-21 15:57:10 +08:00
:alt: sol3 PayPal
:align: middle
.. |ds| image:: media/discord_logo_wordmark.png
:height: 75
:target: https://discord.gg/buxkYNT
:alt: sol3 Discord
.. |gh| image:: media/github_logo.png
:height: 75
:target: https://github.com/ThePhD/sol2/issues
:alt: sol3 Github Issues Page
update funding links and documentation pic layout for GitHub Sponrs
2019-07-06 02:42:24 +08:00
.. |gs| image:: media/github_sponsors_logo.png
:height: 55
:target: https://github.com/users/ThePhD/sponsorship
:alt: sol3 Sponsors Page
Reference in New Issue Copy Permalink