Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,6 @@ Thumbs.db

# Swap files
*.swp

# Sphinx
build
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,24 @@ Furthermore, the project uses branches and tags in the following way:

Feel free to submit [Pull Requests and to file Issues](CONTRIBUTING.md).

The Standard's website (https://yml.publiccode.tools) is built using the Python Sphinx package.

### Prerequisites
- Python 3

### Install dependencies

```console
pip install -r requirements.txt
```

### Local development process
`spinx-build` can be used to compile all source file to static html files. Run this command to generate the website:

```console
sphinx-build docs/standard build -c .
```

## Licence

Licenced under the [CC0-1.0](LICENSE).
31 changes: 31 additions & 0 deletions _templates/layout.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
{% extends '!layout.html' %}

{% block footer %}

<div class="footer">
<p><a href="https://creativecommons.org/publicdomain/zero/1.0/">CC0 1.0 Universal</a> <span style="margin-left:8px; margin-right: 8px;">|</span> <a href="https://github.com/publiccodeyml/publiccode.yml">GitHub</a></p>
</div>

{% endblock %}

{% block header %}

<header class="navbar">
<div class="sidebar-button">
<svg class="icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z" class=""></path>
</svg>
</div>
<a href="index.html" class="home-link">
<span class="site-name">{{ project }}</span>
</a>
<a href="https://github.com/publiccodeyml/publiccode.yml" style="float: right; margin-top: 1px;">
<svg height="32" aria-hidden="true" viewBox="0 0 24 24" version="1.1" width="32" data-view-component="true">
<path fill="#2c3e50" d="M12.5.75C6.146.75 1 5.896 1 12.25c0 5.089 3.292 9.387 7.863 10.91.575.101.79-.244.79-.546 0-.273-.014-1.178-.014-2.142-2.889.532-3.636-.704-3.866-1.35-.13-.331-.69-1.352-1.18-1.625-.402-.216-.977-.748-.014-.762.906-.014 1.553.834 1.769 1.179 1.035 1.74 2.688 1.25 3.349.948.1-.747.402-1.25.733-1.538-2.559-.287-5.232-1.279-5.232-5.678 0-1.25.445-2.285 1.178-3.09-.115-.288-.517-1.467.115-3.048 0 0 .963-.302 3.163 1.179.92-.259 1.897-.388 2.875-.388.977 0 1.955.13 2.875.388 2.2-1.495 3.162-1.179 3.162-1.179.633 1.581.23 2.76.115 3.048.733.805 1.179 1.825 1.179 3.09 0 4.413-2.688 5.39-5.247 5.678.417.36.776 1.05.776 2.128 0 1.538-.014 2.774-.014 3.162 0 .302.216.662.79.547C20.709 21.637 24 17.324 24 12.25 24 5.896 18.854.75 12.5.75Z"></path>
</svg>
</a>
<div class="links">
<nav class="nav-links can-hide"></nav>
</div>
</header>

{% endblock %}
2 changes: 2 additions & 0 deletions conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@

html_theme = "press"

templates_path = ['_templates']

extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.viewcode',
Expand Down