Sphinx

Ik ga er van uit dat je Sphinx en Restructured al geinstalleerd hebt.
Zo niet, hier is een duidelijke uitleg (in het Engels): reStructuredText with Sphinx

Ik heb mijn project opgeslagen als E:\Website\naam_project maar je kunt je project opslaan waar je wilt.

Maak nieuw project

Open commandline
E:
cd E:Websitenaam project
sphinx-quickstart
Er komt nu een hele lijst met vragen langs, de meeste kun je met de (enter) toets doorlopen
Degene die je wel moet beantwoorden zijn:
- Project name: (geef je project een duidelijke naam)
- Author name: (zet hier je eigen naam neer)
- Project version: (begin met 1.0, en vervang deze bij nieuwe versies)

Sphinx Opstarten

Open de Opdrachtprompt
Ga naar
E:
cd E:Websitenaam_project

Open de Verkenner
Ga naar E:Websitenaam_project

Open Notepad++
Open index.rst
Start je browser
Open de pagina waar je aan gaat werken
file:///E:/Website/naam_project/_build/html/index.html

Open in browser de volgende documenten, deze zijn altijd handig als je aan het werk bent.

Korte handleiding RestructuredText: Quick Reference

Documentatie Spinx: Sphinx

Bewerken pagina

Nu kun je veranderen maken in notepad++
Sla veranderingen op
Typ in commandline: make html
en druk op Enter
Je kunt dit commando makkelijk herhalen door op (arrow up) te drukken
Ververs browserpagina

Extra pagina toevoegen

Maak in de map waar je aan het werk bent een nieuw .rst bestand met de naam van de nieuwe pagina.
Zorg dat het bestand geen spaties bevat. Gebruik eventueel een _ om een spatie te simuleren.
Open dit bestand met met notepad++

Typ op regel 1 de index van de pagina:

.. index:: naam pagina
Laat regel 2 leeg
Typ op regel 3 de naam van de pagina
Typ op regel 4 onder de naam ‘=’ tekens
Ga naar de index pagina en voeg de naam van de pagina in op een regel boven Index.
Deze staat nu bij de inhoud

Images toevoegen

Zorg dat de images in de juiste map staan, en zorg dat de mappen geen spaties bevatten.
Sla de images zoveel mogelijk op als .png
Maak de images niet te groot of te klein, ongeveer 400 x 400 px.
Gebruik eventueel een _ om een spatie te simuleren.

Lege regel:

.. image:: Plaatjes\Smile.png
Lege regel

Index maken

Een index maken voor alle pagina’s van het bestand.
De steekwoorden zie je terug in de index pagina van je webpagina.
Zet de index voor het onderwerp dat je gaat behandelen.
Je kunt meerdere indexen achter elkaar plaatsen gescheiden door een komma.

Een index van maar 1 woord:

.. index:: Excel

Een index met meerdere niveau’s:

.. index:: Excel; Tips

Referenties maken

Een referentie maak je als je in een bepaald stuk van je document naar een ander stuk wilt.

Referentie naar lager op de pagina maken

Maak op de regel boven het onderwerp:

.. _Referentie:
Vervang Referentie door de naam van je referentie.

Zet op de plek waar de referentie moet komen:

(`Referentie`_)
Vevang Referentie door de naam van je referentie.

Referentie naar een andere pagina

Zet op de plaats in het document waar je de link wilt hebben:

:doc:`Macros_en_VBA`
Zet de naam van de juiste pagina tussen de ` `

Tabel maken

Er zijn twee manieren om een tabel te maken.

Een eenvoudige en eentje die meer tijd kost om te maken:

EENVOUDIGE TABEL:

=====  =====  ======
   Inputs     Output
------------  ------
  A      B    A or B
=====  =====  ======
False  False  False
True   False  True
False  True   True
True   True   True
=====  =====  ======

COMPLEXE TABEL:

+--------------+---------------+---------------------------+
| Header 1     | Header 2      | Header 3                  |
+==============+===============+===========================+
| Inhoud Rij 1 | Kolom 2       | Kolom 3                   |
+--------------+---------------+---------------------------+
| Inhoud Rij 2 | Cellen mogen over meerdere kolommen lopen.|
+--------------+---------------+---------------------------+
| Inhoud Rij 3 | Cellen mogen  | - Cellen                  |
+--------------+ over meerdere | - hebben                  |
| Inhoud Rij 4 | rijen lopen.  | - blokken.                |
+--------------+---------------+---------------------------+

Voorbeeld:

EENVOUDIGE TABEL:

Inputs Output
A B A or B
False False False
True False True
False True True
True True True

COMPLEXE TABEL:

Header 1 Header 2 Header 3
Inhoud Rij 1 Kolom 2 Kolom 3
Inhoud Rij 2 Cellen mogen over meerdere kolommen lopen.
Inhoud Rij 3 Cellen mogen over meerdere rijen lopen.
  • Cellen
  • hebben
  • blokken.
Inhoud Rij 4

Veel gebruikte symbolen

Hieronder een lijstje met de vaak gebruikte symbolen en acties.

Platte tekst Resultaat Omschrijving
*Voorbeeld* Voorbeeld Italic
**Voorbeeld** Voorbeeld Bold
(``)Voorbeeld(``) Voorbeeld Letterlijk (Gebruik alleen de quotes en niet de haakjes)
.. Commentaar   Commentaar (Commentaar is niet zichtbaar op de webpagina)
`|`+spatie   Als je wilt dat de regels onder elkaar komen i.p.v. achter elkaar
`Link <https://www.python.org/>`_ Link Een losse hyperlink
.. index:: Hoofdstuk; Onderwerp   Een verwijzing in de index maken
.. image::   Een plaatje invoegen `Images-toevoegen`_
.. attention::   Een Let op melding
.. caution:: Pas op Een Pas op melding
.. hint:: Hint Een hint
.. note:: Notitie Een notitie
.. warning:: Waarschuwing Een waarschuwingsmelding in een rood kader

Let op

Dit is een Let op melding

Pas op

Pas op

Hint

Een hint

Notitie

Een notitie

Waarschuwing

Dit is een waarchuwing