Skip to content

Commit afa60d5

Browse files
committed
Create sphinx-deploy.yml
1 parent ee367b7 commit afa60d5

26 files changed

+71
-884836
lines changed
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: Deploy Sphinx documentation to Pages
2+
3+
on:
4+
push:
5+
branches: [main] # branch to trigger deployment
6+
7+
jobs:
8+
pages:
9+
runs-on: ubuntu-latest
10+
environment:
11+
name: github-pages
12+
url: ${{ steps.deployment.outputs.page_url }}
13+
permissions:
14+
pages: write
15+
id-token: write
16+
steps:
17+
- id: deployment
18+
uses: sphinx-notes/pages@v3

.gitlab-ci.yml

Lines changed: 0 additions & 35 deletions
This file was deleted.

00localbuild.sh

Lines changed: 0 additions & 3 deletions
This file was deleted.

COPYING.md

Lines changed: 1 addition & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,3 @@
11
## Per-file attritubion
22

3-
Allan Day, Calum Benson, Adam Elman, Seth Nickell, Colin Robertson:
4-
5-
* buttons.rst
6-
* check-boxes.rst:
7-
* dialogs.rst
8-
* keyboard-interaction.rst
9-
* menus.rst
10-
* radio-buttons.rst
11-
* sliders.rst
12-
* spin-buttons.rst
13-
* text-fields.rst
14-
* progress-bars.rst
15-
* tabs.rst
16-
* model-based.rst
17-
* drop-downs.rst
18-
19-
Allan Day, William Jon McCann:
20-
21-
* typography.rst
22-
23-
Allan Day, Calum Benson, Adam Elman, Seth Nickell, Colin Robertson, Ekaterina Gerasimova:
24-
25-
* writing-style.rst
3+
FIXME

Makefile

Lines changed: 0 additions & 12 deletions
This file was deleted.

README.md

Lines changed: 2 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,3 @@
1-
# Human Interface Guidelines
2-
3-
The GNOME Human Interface Guidelines are the primary source of UX design documentation for GNOME. Live at [developer.gnome.org/hig](https://developer.gnome.org/hig).
4-
5-
This version replaces the previous version which was hosted as part of the [gnome-devel-docs](https://gitlab.gnome.org/GNOME/gnome-devel-docs/) module.
6-
7-
The HIG is written in [reStructuredText](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html), generated using [Sphinx](https://www.sphinx-doc.org/en/master/index.html), and hosted using [GitLab pages](https://docs.gitlab.com/ee/user/project/pages/). It can be viewed online [here](https://developer.gnome.org/hig/).
8-
9-
## Goals for the HIG
10-
11-
Goals:
12-
13-
- App designers and developers are the primary audiences
14-
- Document the most important and commond design patterns
15-
- Be easy to digest: don't be too long or verbose
16-
- Use examples and demos as much as possible
17-
18-
Non-goals:
19-
20-
- Not a generic guide to UX design, and shouldn't try to fill in basic design knowledge, but should be accessible to those with relatively little design expertise
21-
- Don't document every design pattern or possible variation
22-
- Don't be prescriptive: allow designers to make their own choices, and give them the space to be creative
23-
24-
## How to build and edit
25-
26-
Sphinx can be used to build and preview the static html site locally, either with the browser or VS Code.
27-
28-
### 1. Install dependencies
29-
30-
On Fedora, run:
31-
32-
```
33-
dnf install -y python3-sphinx python3-pip
34-
pip3 install --upgrade furo
35-
```
36-
37-
### 2. Make changes
38-
39-
VS Code is a good choice for this, as it is able to preview the source files as rendered HTML.
40-
41-
### 3. Build
42-
43-
Building the docs checks for errors, as well as producing local static HTML of the HIG website.
44-
45-
To build, run `00localbuild.sh` from the project root. The build output can then be found in ``/build``.
46-
47-
### 4. Deploy changes
48-
49-
Changes to `main` branch are automatically deployed to the site using CI.
1+
# Granite.code Docs
502

3+
FIXME

0 commit comments

Comments
 (0)