diff options
| author | Jordan Justen <jordan.l.justen@intel.com> | 2018-12-17 01:13:14 -0800 |
|---|---|---|
| committer | Jordan Justen <jordan.l.justen@intel.com> | 2019-01-07 16:42:41 -0800 |
| commit | 74bc6634d745bc035938092476bb82f6b2bda018 (patch) | |
| tree | 4f58b98abce9bb4df36ee16a43443171317afadc /docs | |
| parent | d93324f90153de070e44c50742181734f27bb05c (diff) | |
README.md: Customize for the piglit project
Signed-off-by: Jordan Justen <jordan.l.justen@intel.com>
Acked-by: Eric Anholt <eric@anholt.net>
Acked-by: Dylan Baker <dylan@pnwbakers.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/README.md | 87 |
1 files changed, 3 insertions, 84 deletions
diff --git a/docs/README.md b/docs/README.md index 191cec518..6a7a676d6 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,88 +1,7 @@ - +Piglit website source code --- -Example [sphinx] documentation website using GitLab Pages. +For dependencies, refer to .gitlab-ci.yml. -Learn more about GitLab Pages at https://pages.gitlab.io and the official -documentation https://docs.gitlab.com/ce/user/project/pages/. - ---- - -<!-- START doctoc generated TOC please keep comment here to allow auto update --> -<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> -**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* - -- [GitLab CI](#gitlab-ci) -- [Requirements](#requirements) -- [Building locally](#building-locally) -- [GitLab User or Group Pages](#gitlab-user-or-group-pages) -- [Did you fork this project?](#did-you-fork-this-project) -- [Troubleshooting](#troubleshooting) - -<!-- END doctoc generated TOC please keep comment here to allow auto update --> - -## GitLab CI - -This project's static Pages are built by [GitLab CI][ci], following the steps -defined in [`.gitlab-ci.yml`](.gitlab-ci.yml): - -``` -image: alpine - -pages: - script: - - apk --no-cache add py2-pip python-dev - - pip install sphinx - - apk --no-cache add make - - make html - - mv _build/html/ public/ - artifacts: - paths: - - public - only: - - master -``` - -## Requirements - -- [Sphinx][] - -## Building locally - -To work locally with this project, you'll have to follow the steps below: - -1. Fork, clone or download this project -1. [Install][sphinx] Sphinx -1. Generate the documentation: `make` - -The generated HTML will be located in the location specified by `conf.py`, -in this case `_build/html`. - -## GitLab User or Group Pages - -To use this project as your user/group website, you will need one additional -step: just rename your project to `namespace.gitlab.io`, where `namespace` is -your `username` or `groupname`. This can be done by navigating to your -project's **Settings**. - -Read more about [user/group Pages][userpages] and [project Pages][projpages]. - -## Did you fork this project? - -If you forked this project for your own use, please go to your project's -**Settings** and remove the forking relationship, which won't be necessary -unless you want to contribute back to the upstream project. - -## Troubleshooting - -No issues reported yet. - ---- - -Forked from https://gitlab.com/Eothred/sphinx - -[ci]: https://about.gitlab.com/gitlab-ci/ -[userpages]: https://docs.gitlab.com/ce/user/project/pages/introduction.html#user-or-group-pages -[projpages]: https://docs.gitlab.com/ce/user/project/pages/introduction.html#project-pages -[sphinx]: http://www.sphinx-doc.org/ +To build website html, run `make html`. |