Version Control¶
Algemeen¶
Het doel van versiebeheer is om als groep met de laatste versie te werken op je harde schijf en niet op de browser te werken. Dit doen we door Bitbucket en Mercurial te gebruiken. Sphinx is een tool om documenten van reStructeredText files(.rst) om te zetten naar bijvoorbeeld een HTML website.
Bitbucket¶
Maak een account op Bitbucket.org om de codes met elkaar te kunnen delen. Als je een account hebt gemaakt, zoek naar Pathways-Extension (Training) van Albert Mietus. Op de hoofdpagina van Pathways-Extension (Training) staat de algemene informatie over dit project.
Fork
Ieder maakt zijn eigen Fork op Bitbucket: Fork > Alles staat goed en maak je Fork repository. Nu staat er bij de hoofdpagina dat ook jouw fork erbij staat. Als je al een fork hebt gemaakt en je wilt je naam veranderen: Ga naar je eigen Fork pagina en ga naar Settings die linksbeneden staat. Je kan dan je naam veranderen.
Clone
Clone je fork van de site, zodat je het op de computer hebt staan. Dit doe je door op je eigen pagina op clone aan de linkerkant te drukken. Kopieer de link en open de command prompt. Verander de locatie als je dat wilt en tik hg clone in en plak erachter de link. Als je dit hebt gedaan dan zou de clone op de aangegeven locatie zijn.
Master
De master van dit project is Albert Mietus en zorgt dat alles dat erop komt, goed staat. De Master accepteert alle wijzigingen die door de anderen zijn gedaan.
Mercurial¶
Mercurial is te downloaden op de volgende link: https://www.mercurial-scm.org/ Als je iets wilt aanpassen, pull dan de laatste versie en merge het met die van jou. Zorg wel ervoor dat jouw status gecommit is en dat je de laatste versie hebt om die met een ander te mergen. Door dit te doen is jouw Local up to date. Hierna kan je de aanpassingen toevoegen en committen. Uiteindelijk heb jij de laatste versie met de aanpassingen en kan je het naar de anderen pushen. Door te pushen kunnen andere teamleden de laatste versie van jou pullen en ermee verder werken.
Pull and Push
Open de map van je project en gebruik de rechtermuisknop op een leeggedeelte van de map>TortoiseHG>Synchronize. In het midden staan de pull en push knoppen en daaronder van wie je het wilt pullen. Als je het van iemand anders wilt pullen, zoek zijn/haar link op via BitBucket.
Merge and Commit
- Mergen: map>TortoiseHG>Update
- Commit: map>HGCommit
Command prompt
Verander eerst je locatie naar die map door (change direction): cd C:...\pathways-extensions-training Daarna kan je door: hg push, hg pull, hg merge, hg commit Daarnaast kan je hg heads gebruiken om de verschillende lijnen te bekijken en om te bekijken met wat je gaat mergen als je dat wilt. Hg status geeft aan of er iets is veranderd en nog niet gecommit is. Voor problemen kan je altijd kijken naar de status: hg status of TortoiseHG>View file status
| Symbol | Description |
|---|---|
| M | Modified |
| A | Added |
| ? | Unknown |
| ! | Missing |
| I | Ignore |
| R | Removed |
Als je bijvoorbeeld een document wilt toevoegen, voeg het eerst bij een directory toe. Daarna moet je naar: map>TortoiseHG>Add files om ze toe te voegen.
Sphinx-doc¶
Op deze pagina: http://www.sphinx-doc.org/en/1.4.8/install.html#windows-install-python-and-sphinx staan de stappen die je moet maken om sphinx te installeren op windows, maar niet alle stappen komen overeen dus volg de stappen hieronder:
Python
Als je Python nog niet hebt, download het op de volgende site: https://www.python.org/downloads/ Download Python 3.5.2 en installeer. Tijdens het installeren, komt er een keer ‘Add python …’ vink dat aan.
Download get-pip.py bij: https://bootstrap.pypa.io/get-pip.py.
- Maak een map aan om dat erin te doen. Open get-pip.py om het te installeren.
- Als je het hebt geinstalleerd, open command prompt en typ: pushd D:...\Sphinx (dus pushd met de locatie van de Sphinx map).
- Ga naar Control PanelSystem and SecuritySystem > Advanced system settings > Environment Variables.
- Voeg bij System Variables>Path de locatie van de pip.exe file toe aan de achterkant. Je voegt dus het volgende aan toe: C:...\Scripts
- Ga daar met je command prompt naartoe en als je van D: naar C: moet gaan. Typ C:
- Dan verandert het en uiteindelijk kan je via cd (change direction) dan de locatie erna toevoegen.
- Als je de juiste locatie hebt, typ : pip
Als dat werkt, tik Sphinx-quickstart. Dan vraagt Command prompt om de locatie waar je het wilt hebben. Vul dat in en daarna:
- Separate source and build directories: No
- Name prefix for templates and static dir: Enter
- Fill your project name and after that your name
- Project version: 1.0
- Project release [1.0]: 1.0.0
- Source file suffix [.rst]: Enter
- Name of your master document (without suffix) [index]: Houd het op default, dus alleen enter
- Autodoc: yes
Daarna komen er andere vragen, maar die kan je negeren totdat ze vragen over ‘Create Makefile’. Tik y in en daarna vragen ze of je het op Windows doet.
- Verander de locatie bij Command prompt naar de locatie waar sphinx-build staat (Scripts map).
- Typ dan bij Command prompt: Sphinx-build –b html ‘Source directory’ ‘Build directory’
- Het is dus bijv: Sphinx-build –b html D:...\ Sphinx D:...\Sphinx\_build
- Als het de map niet kan vinden, kopieer je map naar de desktop en verander hetgene wat je typte naar de locatie van je Sphinx map op de desktop. Door dit te doen, maak je een html.
- Door de locatie van je Command prompt te veranderen naar de locatie van make.bat die bij de map Sphinx staat, kan je wel ‘make html’ gebruiken.
- Je kan je HTML openen in de map van Sphinx>_build>html>index.html.
Als je er niet uitkomt, zoek op youtube naar ‘Using Sphinx to Document Python Code’. Daar leggen ze uit wat je moet doen, alleen is het voor linux bedoelt.
Documentatie bewerken
De html site is gemaakt uit de index.rst die je met Notepad kan openen en bewerken. Als je het hebt bewerkt moet je bij Command prompt opnieuw ‘make html’ doen om het up te daten.
Thema veranderen
Als eerst installeer je een nieuwe thema door bij command prompt: ‘pip install sphinx _rtd_theme’. Je locatie bij command prompt is bij je Sphinx map waar conf.py staat. Na het installeren moet je de conf.py editted door Edit with IDLE> Edit with IDLE 3.5 (32-bit). Je opent dan een document en zoek naar html_theme. Verder de huidige theme naar ‘sphinx_rtd_theme’ die je zojuist hebt geinstalleerd. Als je nu weer make html doet dan is de thema van je html verandert.
Add Figure
‘.. figure:: ‘LOCATIE’’
Sphinx kan geen jpeg openen, maar wel png.
Link
Als eerst moet je een extra RST file aanmaken om die te linken aan het woord. De RST file staat dan in je Sphinx map.
Voor meer informatie kan je de documentatie bekijken: https://media.readthedocs.org/pdf/sphinx/stable/sphinx.pdf
Notepad ++
Download Notepad ++ 7.2 op de volgende site: https://notepad-plus-plus.org/download/v7.2.html Notepad ++ maakt het makkelijker voor Sphinx en hgignore.