Skip to content

Commit

Permalink
Rename classes folder to api (#10)
Browse files Browse the repository at this point in the history
  • Loading branch information
DanielaOrtner authored Jan 27, 2024
2 parents dfe3461 + 0a635f7 commit d3e14b7
Show file tree
Hide file tree
Showing 715 changed files with 1,470 additions and 1,501 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@ If you plan on making significant contributions to Rebel Documentation,
you will want to learn how to use Git.
For good tutorials on using Git, try the [Atlassian Git Tutorials](https://www.atlassian.com/git/tutorials).

The Rebel Engine API documentation files are included under the `classes` folder.
They are automatically generated from Rebel Engine's [XML class references](https://github.com/RebelToolbox/RebelEngine/tree/main/doc/classes).
The Rebel Engine API documentation files are included under the `api` folder.
They are automatically generated from Rebel Engine's [XML docs](https://github.com/RebelToolbox/RebelEngine/tree/main/docs).
These are maintained in [Rebel Engine](https://github.com/RebelToolbox/RebelEngine) under the `doc` folder.
Please make updates and Pull Requests to the API documenation there.
See the [Contributing to the Class Reference](https://docs.rebeltoolbox.com/en/latest/contributing/updating_the_class_reference.html) documentation for more information.
Please make updates and Pull Requests to the API documentation there.
See the [Contributing to the API Documentation](https://docs.rebeltoolbox.com/en/latest/contributing/updating_the_api_documentation.html) for more information.

To edit an existing page, simply click on the "Edit on GitHub" link in the top, right-hand corner of the page.
There, the file can be edited directly on Github.
Expand Down Expand Up @@ -95,6 +95,6 @@ You can view your changes by opening `_build/html/index.html` in your favorite b

## License

With the exception of the `classes` folder, all the content in this repository is licensed under the Creative Commons Attribution 4.0 International Public License ([CC BY 4.0](https://creativecommons.org/licenses/by/4.0/)). Attribution should be made to the Rebel Documentation Contributors and/or the specific author.
With the exception of the `api` folder, all the content in this repository is licensed under the Creative Commons Attribution 4.0 International Public License ([CC BY 4.0](https://creativecommons.org/licenses/by/4.0/)). Attribution should be made to the Rebel Documentation Contributors and/or the specific author.

The files in the `classes` folder are derived from [Rebel Engine](https://github.com/RebelToolbox/RebelEngine) and are distributed under the MIT license.
The files in the `api` folder are derived from [Rebel Engine](https://github.com/RebelToolbox/RebelEngine) and are distributed under the MIT license.
2 changes: 1 addition & 1 deletion _static/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -913,7 +913,7 @@ kbd.compound > .kbd,

.wy-menu-vertical li.current a {
/* Make long words always display on a single line, keep wrapping for multiple words */
/* This fixes the class reference titles' display with very long class names */
/* This fixes the display of very long class names in the API documentation */
display: flex;
}

Expand Down
4 changes: 2 additions & 2 deletions about/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -83,10 +83,10 @@ relatively intuitive:
- The :ref:`sec-contributing` section gives information related to contributing to
engine development, how to report bugs,
help with the documentation, etc.
- Finally, the :ref:`sec-class-ref` is the documentation of the Rebel Engine API,
- Finally, the :ref:`sec-api` is the documentation of the Rebel Engine API,
which is also available directly within the engine's script editor. It is
generated automatically from a file in the main source repository, therefore
the generated files of the documentation are not meant to be modified. See
:ref:`doc_updating_the_class_reference` for details.
:ref:`doc_updating_the_api_documentation` for details.

Have fun reading and making games with Rebel Engine!
4 changes: 2 additions & 2 deletions classes/class_@gdscript.rst → api/class_@gdscript.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
:github_url: hide

.. Generated automatically by doc/tools/make_rst.py in Rebel Engine's source tree.
.. Generated automatically by tools/scripts/make_rst.py in Rebel Engine's source tree.
.. DO NOT EDIT THIS FILE, but the @GDScript.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. The source is found in docs or modules/<name>/docs.
.. _class_@GDScript:

Expand Down
4 changes: 2 additions & 2 deletions classes/class_@globalscope.rst → api/class_@globalscope.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
:github_url: hide

.. Generated automatically by doc/tools/make_rst.py in Rebel Engine's source tree.
.. Generated automatically by tools/scripts/make_rst.py in Rebel Engine's source tree.
.. DO NOT EDIT THIS FILE, but the @GlobalScope.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. The source is found in docs or modules/<name>/docs.
.. _class_@GlobalScope:

Expand Down
4 changes: 2 additions & 2 deletions classes/class_aabb.rst → api/class_aabb.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
:github_url: hide

.. Generated automatically by doc/tools/make_rst.py in Rebel Engine's source tree.
.. Generated automatically by tools/scripts/make_rst.py in Rebel Engine's source tree.
.. DO NOT EDIT THIS FILE, but the AABB.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. The source is found in docs or modules/<name>/docs.
.. _class_AABB:

Expand Down
4 changes: 2 additions & 2 deletions classes/class_acceptdialog.rst → api/class_acceptdialog.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
:github_url: hide

.. Generated automatically by doc/tools/make_rst.py in Rebel Engine's source tree.
.. Generated automatically by tools/scripts/make_rst.py in Rebel Engine's source tree.
.. DO NOT EDIT THIS FILE, but the AcceptDialog.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. The source is found in docs or modules/<name>/docs.
.. _class_AcceptDialog:

Expand Down
4 changes: 2 additions & 2 deletions classes/class_aescontext.rst → api/class_aescontext.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
:github_url: hide

.. Generated automatically by doc/tools/make_rst.py in Rebel Engine's source tree.
.. Generated automatically by tools/scripts/make_rst.py in Rebel Engine's source tree.
.. DO NOT EDIT THIS FILE, but the AESContext.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. The source is found in docs or modules/<name>/docs.
.. _class_AESContext:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
:github_url: hide

.. Generated automatically by doc/tools/make_rst.py in Rebel Engine's source tree.
.. Generated automatically by tools/scripts/make_rst.py in Rebel Engine's source tree.
.. DO NOT EDIT THIS FILE, but the AnimatedSprite.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. The source is found in docs or modules/<name>/docs.
.. _class_AnimatedSprite:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
:github_url: hide

.. Generated automatically by doc/tools/make_rst.py in Rebel Engine's source tree.
.. Generated automatically by tools/scripts/make_rst.py in Rebel Engine's source tree.
.. DO NOT EDIT THIS FILE, but the AnimatedSprite3D.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. The source is found in docs or modules/<name>/docs.
.. _class_AnimatedSprite3D:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
:github_url: hide

.. Generated automatically by doc/tools/make_rst.py in Rebel Engine's source tree.
.. Generated automatically by tools/scripts/make_rst.py in Rebel Engine's source tree.
.. DO NOT EDIT THIS FILE, but the AnimatedTexture.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. The source is found in docs or modules/<name>/docs.
.. _class_AnimatedTexture:

Expand Down
4 changes: 2 additions & 2 deletions classes/class_animation.rst → api/class_animation.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
:github_url: hide

.. Generated automatically by doc/tools/make_rst.py in Rebel Engine's source tree.
.. Generated automatically by tools/scripts/make_rst.py in Rebel Engine's source tree.
.. DO NOT EDIT THIS FILE, but the Animation.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. The source is found in docs or modules/<name>/docs.
.. _class_Animation:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
:github_url: hide

.. Generated automatically by doc/tools/make_rst.py in Rebel Engine's source tree.
.. Generated automatically by tools/scripts/make_rst.py in Rebel Engine's source tree.
.. DO NOT EDIT THIS FILE, but the AnimationNode.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. The source is found in docs or modules/<name>/docs.
.. _class_AnimationNode:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
:github_url: hide

.. Generated automatically by doc/tools/make_rst.py in Rebel Engine's source tree.
.. Generated automatically by tools/scripts/make_rst.py in Rebel Engine's source tree.
.. DO NOT EDIT THIS FILE, but the AnimationNodeAdd2.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. The source is found in docs or modules/<name>/docs.
.. _class_AnimationNodeAdd2:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
:github_url: hide

.. Generated automatically by doc/tools/make_rst.py in Rebel Engine's source tree.
.. Generated automatically by tools/scripts/make_rst.py in Rebel Engine's source tree.
.. DO NOT EDIT THIS FILE, but the AnimationNodeAdd3.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. The source is found in docs or modules/<name>/docs.
.. _class_AnimationNodeAdd3:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
:github_url: hide

.. Generated automatically by doc/tools/make_rst.py in Rebel Engine's source tree.
.. Generated automatically by tools/scripts/make_rst.py in Rebel Engine's source tree.
.. DO NOT EDIT THIS FILE, but the AnimationNodeAnimation.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. The source is found in docs or modules/<name>/docs.
.. _class_AnimationNodeAnimation:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
:github_url: hide

.. Generated automatically by doc/tools/make_rst.py in Rebel Engine's source tree.
.. Generated automatically by tools/scripts/make_rst.py in Rebel Engine's source tree.
.. DO NOT EDIT THIS FILE, but the AnimationNodeBlend2.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. The source is found in docs or modules/<name>/docs.
.. _class_AnimationNodeBlend2:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
:github_url: hide

.. Generated automatically by doc/tools/make_rst.py in Rebel Engine's source tree.
.. Generated automatically by tools/scripts/make_rst.py in Rebel Engine's source tree.
.. DO NOT EDIT THIS FILE, but the AnimationNodeBlend3.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. The source is found in docs or modules/<name>/docs.
.. _class_AnimationNodeBlend3:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
:github_url: hide

.. Generated automatically by doc/tools/make_rst.py in Rebel Engine's source tree.
.. Generated automatically by tools/scripts/make_rst.py in Rebel Engine's source tree.
.. DO NOT EDIT THIS FILE, but the AnimationNodeBlendSpace1D.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. The source is found in docs or modules/<name>/docs.
.. _class_AnimationNodeBlendSpace1D:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
:github_url: hide

.. Generated automatically by doc/tools/make_rst.py in Rebel Engine's source tree.
.. Generated automatically by tools/scripts/make_rst.py in Rebel Engine's source tree.
.. DO NOT EDIT THIS FILE, but the AnimationNodeBlendSpace2D.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. The source is found in docs or modules/<name>/docs.
.. _class_AnimationNodeBlendSpace2D:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
:github_url: hide

.. Generated automatically by doc/tools/make_rst.py in Rebel Engine's source tree.
.. Generated automatically by tools/scripts/make_rst.py in Rebel Engine's source tree.
.. DO NOT EDIT THIS FILE, but the AnimationNodeBlendTree.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. The source is found in docs or modules/<name>/docs.
.. _class_AnimationNodeBlendTree:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
:github_url: hide

.. Generated automatically by doc/tools/make_rst.py in Rebel Engine's source tree.
.. Generated automatically by tools/scripts/make_rst.py in Rebel Engine's source tree.
.. DO NOT EDIT THIS FILE, but the AnimationNodeOneShot.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. The source is found in docs or modules/<name>/docs.
.. _class_AnimationNodeOneShot:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
:github_url: hide

.. Generated automatically by doc/tools/make_rst.py in Rebel Engine's source tree.
.. Generated automatically by tools/scripts/make_rst.py in Rebel Engine's source tree.
.. DO NOT EDIT THIS FILE, but the AnimationNodeOutput.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. The source is found in docs or modules/<name>/docs.
.. _class_AnimationNodeOutput:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
:github_url: hide

.. Generated automatically by doc/tools/make_rst.py in Rebel Engine's source tree.
.. Generated automatically by tools/scripts/make_rst.py in Rebel Engine's source tree.
.. DO NOT EDIT THIS FILE, but the AnimationNodeStateMachine.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. The source is found in docs or modules/<name>/docs.
.. _class_AnimationNodeStateMachine:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
:github_url: hide

.. Generated automatically by doc/tools/make_rst.py in Rebel Engine's source tree.
.. Generated automatically by tools/scripts/make_rst.py in Rebel Engine's source tree.
.. DO NOT EDIT THIS FILE, but the AnimationNodeStateMachinePlayback.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. The source is found in docs or modules/<name>/docs.
.. _class_AnimationNodeStateMachinePlayback:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
:github_url: hide

.. Generated automatically by doc/tools/make_rst.py in Rebel Engine's source tree.
.. Generated automatically by tools/scripts/make_rst.py in Rebel Engine's source tree.
.. DO NOT EDIT THIS FILE, but the AnimationNodeStateMachineTransition.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. The source is found in docs or modules/<name>/docs.
.. _class_AnimationNodeStateMachineTransition:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
:github_url: hide

.. Generated automatically by doc/tools/make_rst.py in Rebel Engine's source tree.
.. Generated automatically by tools/scripts/make_rst.py in Rebel Engine's source tree.
.. DO NOT EDIT THIS FILE, but the AnimationNodeTimeScale.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. The source is found in docs or modules/<name>/docs.
.. _class_AnimationNodeTimeScale:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
:github_url: hide

.. Generated automatically by doc/tools/make_rst.py in Rebel Engine's source tree.
.. Generated automatically by tools/scripts/make_rst.py in Rebel Engine's source tree.
.. DO NOT EDIT THIS FILE, but the AnimationNodeTimeSeek.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. The source is found in docs or modules/<name>/docs.
.. _class_AnimationNodeTimeSeek:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
:github_url: hide

.. Generated automatically by doc/tools/make_rst.py in Rebel Engine's source tree.
.. Generated automatically by tools/scripts/make_rst.py in Rebel Engine's source tree.
.. DO NOT EDIT THIS FILE, but the AnimationNodeTransition.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. The source is found in docs or modules/<name>/docs.
.. _class_AnimationNodeTransition:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
:github_url: hide

.. Generated automatically by doc/tools/make_rst.py in Rebel Engine's source tree.
.. Generated automatically by tools/scripts/make_rst.py in Rebel Engine's source tree.
.. DO NOT EDIT THIS FILE, but the AnimationPlayer.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. The source is found in docs or modules/<name>/docs.
.. _class_AnimationPlayer:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
:github_url: hide

.. Generated automatically by doc/tools/make_rst.py in Rebel Engine's source tree.
.. Generated automatically by tools/scripts/make_rst.py in Rebel Engine's source tree.
.. DO NOT EDIT THIS FILE, but the AnimationRootNode.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. The source is found in docs or modules/<name>/docs.
.. _class_AnimationRootNode:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
:github_url: hide

.. Generated automatically by doc/tools/make_rst.py in Rebel Engine's source tree.
.. Generated automatically by tools/scripts/make_rst.py in Rebel Engine's source tree.
.. DO NOT EDIT THIS FILE, but the AnimationTrackEditPlugin.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. The source is found in docs or modules/<name>/docs.
.. _class_AnimationTrackEditPlugin:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
:github_url: hide

.. Generated automatically by doc/tools/make_rst.py in Rebel Engine's source tree.
.. Generated automatically by tools/scripts/make_rst.py in Rebel Engine's source tree.
.. DO NOT EDIT THIS FILE, but the AnimationTree.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. The source is found in docs or modules/<name>/docs.
.. _class_AnimationTree:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
:github_url: hide

.. Generated automatically by doc/tools/make_rst.py in Rebel Engine's source tree.
.. Generated automatically by tools/scripts/make_rst.py in Rebel Engine's source tree.
.. DO NOT EDIT THIS FILE, but the AnimationTreePlayer.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. The source is found in docs or modules/<name>/docs.
.. _class_AnimationTreePlayer:

Expand Down
4 changes: 2 additions & 2 deletions classes/class_area.rst → api/class_area.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
:github_url: hide

.. Generated automatically by doc/tools/make_rst.py in Rebel Engine's source tree.
.. Generated automatically by tools/scripts/make_rst.py in Rebel Engine's source tree.
.. DO NOT EDIT THIS FILE, but the Area.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. The source is found in docs or modules/<name>/docs.
.. _class_Area:

Expand Down
Loading

0 comments on commit d3e14b7

Please sign in to comment.