Skip to content

Commit

Permalink
Reorganise main tutorial to be easier to maintain and see contents of…
Browse files Browse the repository at this point in the history
… each chapter
  • Loading branch information
colinkiama committed May 3, 2024
1 parent 4f41379 commit c4f3a47
Show file tree
Hide file tree
Showing 17 changed files with 53 additions and 93 deletions.
10 changes: 10 additions & 0 deletions source/tutorials/main/02-00-basics.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
Basics
======

.. toctree::
:glob:
:maxdepth: 2

02-00-basics/*


16 changes: 0 additions & 16 deletions source/tutorials/main/02-00-basics/index.rst

This file was deleted.

9 changes: 9 additions & 0 deletions source/tutorials/main/03-00-object-oriented-programming.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Object Oriented Programming
===========================

.. toctree::
:glob:
:maxdepth: 2

03-00-object-oriented-programming/*

21 changes: 0 additions & 21 deletions source/tutorials/main/03-00-object-oriented-programming/index.rst

This file was deleted.

9 changes: 9 additions & 0 deletions source/tutorials/main/04-00-advanced-features.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Advanced Features
=================

.. toctree::
:glob:
:maxdepth: 2

04-00-advanced-features/*

22 changes: 0 additions & 22 deletions source/tutorials/main/04-00-advanced-features/index.rst

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,8 @@ Experimental Features
Some features of Vala are experimental. This means they are not fully tested and might be subject to changes in future versions.

.. toctree::
:maxdepth: 1
:glob:
:maxdepth: 2

05-01-chained-relational-expressions
05-02-regular-expression-literals
05-03-strict-non-null-mode
05-00-experimental-features/*

Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ Both of which are installed in the standard locations. And the Vala specific fil
These files are explained later in this section. It should be noted that the library names are the same in the Vala specific files as in the *pkg-config* files.

.. toctree::
:maxdepth: 1
:glob:
:maxdepth: 2

06-00-libraries/*

06-01-using-libraries
06-02-creating-a-library
06-03-binding-libraries-with-vapi-files

Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ This process of creating this generally amounts to three steps,
* Adding extra metadata to standardise the interface or make various other changes.
* Generating a VAPI file from the above sources using *vapigen*.

Specific instructions on how to generate bindings are in the :doc:`Vala Bindings Tutorial </tutorials/bindings>`.
Specific instructions on how to generate bindings are in the :doc:`Vala Bindings Tutorial </developer-guides/bindings>`.

Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ Tools
The Vala distribution includes several programs to help you build and work with Vala applications. For more details of each tool, see the man pages.

.. toctree::
:maxdepth: 1
:glob:
:maxdepth: 2

07-01-valac
07-02-vapigen
07-03-vala-gen-introspect
07-00-tools/*



2 changes: 1 addition & 1 deletion source/tutorials/main/07-00-tools/07-01-valac.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Vala has better information than the C compiler, so it knows certain things are

Unfortunately we can't just add casts everywhere since there are situations where we can't generate a valid cast (and, what's more, no way to know what those situations are).

For example, compiling the :doc:`Hello World program </tutorials/main/01-00-first-program/index>` will give us some warnings because ``valac`` by default generates code which is compatible with older versions of the ``GLib``.Some methods may have been deprecated in your new version of GLib so that C language compiler will warn you.
For example, compiling the :doc:`Hello World program </tutorials/main/01-00-first-program>` will give us some warnings because ``valac`` by default generates code which is compatible with older versions of the ``GLib``.Some methods may have been deprecated in your new version of GLib so that C language compiler will warn you.

Imagine a machine with older glib version want to run your vala program!

Expand Down
2 changes: 1 addition & 1 deletion source/tutorials/main/07-00-tools/07-02-vapigen.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
vapigen
=======

``vapigen`` is a tool to make bindings. It creates a VAPI files from a library's metadata and any extra information required. See also :doc:`Vala Bindings Tutorial </tutorials/bindings>`.
``vapigen`` is a tool to make bindings. It creates a VAPI files from a library's metadata and any extra information required. See also :doc:`Vala Bindings Tutorial </developer-guides/bindings/generating-a-vapi-with-gobject-introspection>`.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
vala-gen-introspect
===================

``vala-gen-introspect`` is a tool for extracting metainformation about GObject based libraries. Nowadays, the preferred method is to use GObjectIntrospection instead, as vapigen can use GIR files directly. See also :doc:`Vala Bindings Tutorial </tutorials/bindings>`.
``vala-gen-introspect`` is a tool for extracting metainformation about GObject based libraries. Nowadays, the preferred method is to use GObjectIntrospection instead, as vapigen can use GIR files directly. See also :doc:`Vala Bindings Tutorial <developer-guides/bindings/generating-a-vapi-with-gobject-introspection>`.
8 changes: 8 additions & 0 deletions source/tutorials/main/08-00-techniques.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Techniques
==========

.. toctree::
:glob:
:maxdepth: 2

08-00-techniques/*
9 changes: 0 additions & 9 deletions source/tutorials/main/08-00-techniques/index.rst

This file was deleted.

11 changes: 2 additions & 9 deletions source/tutorials/main/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,13 +43,6 @@ At some point I will add in references to the Vala documentation, but that isn't
.. toctree::
:numbered:
:maxdepth: 1
:glob:

01-00-first-program/index
02-00-basics/index
03-00-object-oriented-programming/index
04-00-advanced-features/index
05-00-experimental-features/index
06-00-libraries/index
07-00-tools/index
08-00-techniques/index

*

0 comments on commit c4f3a47

Please sign in to comment.