reStructuredText
For the eZ components we are currently writing introductionary tutorials for each component. These tutorials should be a first start in understanding the abilities of each specific component without having to go through the full API documentation.
As good programmers we hate to document and thus the easier we can make the process the better documentation we will get. For our internal documents we use plain text files in SVN, describing guidelines and conventions. Those text files are formatted using reStructuredText , a format used by the Python community. It is a very easy to remember syntax, wiki-like, and it is easy to convert to HTML. We also decided to used the same format for our tutorials because it is such an easy format. With a specific PHP script we generate HTML from the tutorials, and add links to the other documentation that is generated by phpDocumentor from our inline API documentation.
Comments
Did you also check markdown and what where your reasons to choose restructured text?
Basically because some of us were already familiar with it. For example I've been using it to document Xdebug's DBGp protocol (http://xdebug.org/docs-dbgp.php). I had also never heard of markdown before, but their syntax seems to be very similar to the one that reStructuredText uses.
Another important benefit of using reStructuredText is that the documentation file (source) without parsing is also very readable.
Life Line
Little Owl owlet
This lovely owlet was quite easy to find in a London Park, with some help as they camouflage so well!
I saw its sibling too.
#BirdPhotography #BirdsOfFediverse #Photography #Nature #London #BirdsOfMastodon
I went to a park (Bushy Park) to look for some owls.
I found Owls (Little and Tawny), but also a Green Woodpecker and two Kingfishers.
Snaps from my camera screen, and real photos will follow, but not of the Kingfishers as they were too far away and the photos are blurry.
#london #BirdPhotogaphy #BirdsOfMastodon #Birds #photography #BirdsOfFediverse #BushyPark
I hiked 13.8km in 4h44m12s
Created a chocolate shop and a restaurant; Updated 6 restaurants and an address; Confirmed 5 restaurants, a community_centre, and 3 other objects
Created a restaurant, a fast_food, and 2 other objects; Deleted a restaurant
I walked 8.5km in 1h31m45s
Created 2 buildings and a hairdresser shop; Updated a restaurant and an estate_agent office; Confirmed a cafe
I walked 2.2km in 38m09s
Merged pull request #1096
Bump actions/checkout from 6 to 7
Merged pull request #1095
Improve Tiverton Green mapping
Created 2 gates
I walked 7.1km in 1h23m15s
I walked 1.0km in 9m24s
Realign streets. They now have much less wide corners into each other.
Updated a fast_food
I walked 9.1km in 1h35m41s
I hiked 4.7km in 3h24m10s
I walked 6.7km in 1h12m03s
I walked 7.7km in 1h47m24s
Updated a pub
Updated a pub
Created a bar; Updated a bar; Confirmed a restaurant and a bar
Shortlink
This article has a short URL available: https://drck.me/r-4nt