opendata-swiss/convention-handbook
Watch
2
mirror of https://github.com/opendata-swiss/convention-handbook.git synced 2026-08-26 12:14:22 +00:00
Code Releases Activity
Read-only mirror of https://github.com/opendata-swiss/convention-handbook — opendata.swiss. Issues & pull requests at the source.
19 commits 3 branches 1 tag 271 KiB
  • CSS 45.8%
  • Python 15.9%
  • JavaScript 15.8%
  • HTML 15.4%
  • Batchfile 3.9%
  • Other 3.2%
Find a file
Exact
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Rae Knowler 747892a33f
 Create LICENSE
2022-01-13 11:53:11 +01:00
source add coverage convention 2021-05-07 17:32:38 +02:00
.gitignore add installation instructions for a static server 2021-04-19 09:45:33 +02:00
LICENSE Create LICENSE 2022-01-13 11:53:11 +01:00
make.bat add sphinx infrastructure and gitignore file 2021-04-18 10:35:36 +02:00
Makefile add sphinx infrastructure and gitignore file 2021-04-18 10:35:36 +02:00
README.md Update README.md 2022-01-13 11:31:57 +01:00
requirements.txt add sphinx infrastructure and gitignore file 2021-04-18 10:35:36 +02:00

README.md

Convention Handbook for opendata.swiss

About

Convention handbook on the application and further development of the DCAT-AP-CH.

The handbook is implemented with Sphinx.

Installation

The handbook uses Python3:

Set up a virtual environment:

python3 -m venv p3venv 
cd ogdch-convention-handbook

With the virtualenv activated: install the requirements:

source p3venv/bin/activate
(p3venv)pip install -r requirements.txt

Build the Documentation

The documentation can be built locally:

(p3venv)cd docs
(p3venv)make clean
(p3venv)make html

Use

No special server is needed:

  • go to docs/build/html and
  • run index.html in a browser of your choice

Linkchecker

The documentation includes a check of its external links.

You can run it with make:

(p3venv)make linkcheck