Using the wiki
To add/update this wiki, simply push Edit on GitHub button in the top-right corner. You don’t need to fork it, but have to be a part of github.com/text-machine-lab in order to push directly into the master branch and this is a recommended way to edit text-machine wiki. The website is automatically updated after a push to the repository, so you don’t need to do anything else (just to wait about a minute or so).
We prefer Markdown over reStructuredText text in this wiki (cheatsheet, How to use Markdown for writing Docs) as it is simpler to start with and we want to encourage you to help us maintain this wiki up to date. If you really need to use reST (we do advise against this as it raises the bar for new people), here’s a nice cheatsheet.
However, do not update either of make.bat, index.rst, history.rst, conf.py or Makefile without knowing how Sphinx works and what you are actually doing.
Also, please check you changes before the commit using “Preview changes” button on GitHub. Markdown is easy, but it can be tricky sometimes.
Including images
If you want to include an image to a wiki page, use
for external URLs (preferred method).
In the case of your own images, place them to docs/img directory and specify a local path in the markdown
You can also use HTML (but keep things simple), for example, if you want to control image size
<img src="./img/my-image.png" width="300"/>
OR
<figure>
<img src='./img/my-image.png' width="300"/>
<figcaption>My image capiton</figcaption>
</figure>
Internal links
Markdown does not support internal links (to local .md files), but there is a workaround. Use external links to this website, e.g.
[Link to Usage section](https://text-machine-wiki.readthedocs.io/en/latest/usage.html)
Maitainer info
This wiki is hosted using readthedocs.org, you can ask Vlad for the credentials. A good example of Sphinx usage (and common python practices) can be found in this project.
Here are some Sphinx extentions you may want to include at some point: