Skip to content

Commit

Permalink
adjustments for static website generation and linking
Browse files Browse the repository at this point in the history
  • Loading branch information
palmskog authored and chdoc committed Feb 24, 2020
1 parent f2a2f00 commit 1b9becb
Show file tree
Hide file tree
Showing 8 changed files with 115 additions and 4 deletions.
3 changes: 3 additions & 0 deletions Makefile.coq.local
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,8 @@ coqdoc: $(GLOBFILES) $(VFILES) $(CSSFILES) $(JSFILES) $(HTMLFILES)
$(HIDE)cp $(CSSFILES) $(JSFILES) $(COQDOCDIR)
.PHONY: coqdoc

extra/index.html: extra/index.md
pandoc -s -o $@ $<

clean::
$(HIDE)rm -rf $(DOCDIR)
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
[![Contributing][contributing-shield]][contributing-link]
[![Code of Conduct][conduct-shield]][conduct-link]
[![Gitter][gitter-shield]][gitter-link]
[![coqdoc][coqdoc-shield]][coqdoc-link]
[![DOI][doi-shield]][doi-link]

[travis-shield]: https://travis-ci.com/coq-community/reglang.svg?branch=master
Expand All @@ -18,6 +19,8 @@
[gitter-shield]: https://img.shields.io/badge/chat-on%20gitter-%23c1272d.svg
[gitter-link]: https://gitter.im/coq-community/Lobby

[coqdoc-shield]: https://img.shields.io/badge/docs-coqdoc-blue.svg
[coqdoc-link]: https://coq-community.github.io/reglang/docs/latest/coqdoc/toc.html

[doi-shield]: https://zenodo.org/badge/DOI/10.1007/s10817-018-9460-x.svg
[doi-link]: https://doi.org/10.1007/s10817-018-9460-x
Expand Down Expand Up @@ -69,7 +72,7 @@ make install

To generate HTML documentation, run `make coqdoc` and point your browser at `docs/coqdoc/toc.html`.

Pregenerated HTML documentation can be found at: https://www.ps.uni-saarland.de/extras/RLR-Coq
See also the pregenerated HTML documentation for the [latest release](https://coq-community.github.io/reglang/docs/latest/coqdoc/toc.html).

## File Contents

Expand Down
1 change: 1 addition & 0 deletions coq-reglang.opam
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ version: "dev"
homepage: "https://github.com/coq-community/reglang"
dev-repo: "git+https://github.com/coq-community/reglang.git"
bug-reports: "https://github.com/coq-community/reglang/issues"
doc: "https://coq-community.github.io/reglang/"
license: "CECILL-B"

synopsis: "Representations of regular languages (i.e., regexps, various types of automata, and WS1S) with equivalence proofs, in Coq and MathComp"
Expand Down
2 changes: 1 addition & 1 deletion extra/footer.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
</div>
<div id="footer">
Generated by <a href="http://coq.inria.fr/">coqdoc</a> and improved with <a href="https://github.com/tebbi/coqdocjs">CoqdocJS</a>
Generated by <a href="http://coq.inria.fr/">coqdoc</a> and improved with <a href="https://github.com/coq-community/coqdocjs">CoqdocJS</a>
</div>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion extra/header.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<span class="button" id="toggle-proofs"></span>

<span class="right">
<a href="../">Project Page</a>
<a href="./../../..">Project Website</a>
<a href="./indexpage.html"> Index </a>
<a href="./toc.html"> Table of Contents </a>
</span>
Expand Down
50 changes: 50 additions & 0 deletions extra/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta name="generator" content="pandoc" />
<title>Regular Language Representations in Coq</title>
<style type="text/css">code{white-space: pre;}</style>
<style type="text/css"> body {font-family: Arial, Helvetica; margin-left: 5em; font-size: large;} </style>
<style type="text/css"> h1 {margin-left: 0em; padding: 0px; text-align: center} </style>
<style type="text/css"> h2 {margin-left: 0em; padding: 0px; color: #580909} </style>
<style type="text/css"> h3 {margin-left: 1em; padding: 0px; color: #C05001;} </style>
<style type="text/css"> body { width: 1100px; margin-left: 30px; }</style>
</head>
<body>
<div id="header">
<h1 class="title">Regular Language Representations in Coq</h1>
</div>
<div style="text-align:left">
<img src="https://github.githubassets.com/images/modules/logos_page/Octocat.png" height="25" style="border:0px"> <a href="https://github.com/coq-community/reglang">View the project on GitHub</a> <img src="https://github.githubassets.com/images/modules/logos_page/Octocat.png" height="25" style="border:0px">
</div>
<h2 id="about">About</h2>
<p>Welcome to the Regular Language Representations in Coq project website! This project is part of <a href="https://github.com/coq-community/manifesto">coq-community</a>.</p>
<p>This library provides definitions and verified translations between different representations of regular languages: various forms of automata (deterministic, nondeterministic, one-way, two-way), regular expressions, and the logic WS1S. It also contains various decidability results and closure properties of regular languages.</p>
<p>This is an open source project, licensed under CeCILL-B.</p>
<h2 id="get-the-code">Get the code</h2>
<p>The current stable release of Regular Language Representations in Coq can be <a href="https://github.com/coq-community/reglang/releases">downloaded from GitHub</a>.</p>
<h2 id="documentation">Documentation</h2>
<p>The coqdoc presentations of releases can be browsed online:</p>
<ul>
<li><a href="docs/v1.1/coqdoc/toc.html">v1.1</a></li>
</ul>
<p>Other related publications, if any, are listed below.</p>
<ul>
<li><a href="https://hal.archives-ouvertes.fr/hal-01832031/document">Regular Language Representations in the Constructive Type Theory of Coq</a> doi:<a href="https://doi.org/10.1007/s10817-018-9460-x">10.1007/s10817-018-9460-x</a></li>
</ul>
<h2 id="help-and-contact">Help and contact</h2>
<ul>
<li>Report issues on <a href="https://github.com/coq-community/reglang/issues">GitHub</a></li>
<li>Chat with us on <a href="https://gitter.im/coq-community/Lobby">Gitter</a></li>
<li>Discuss with us on Coq's <a href="https://coq.discourse.group">Discourse</a> forum</li>
</ul>
<h2 id="authors-and-contributors">Authors and contributors</h2>
<ul>
<li>Christian Doczkal</li>
<li>Jan-Oliver Kaiser</li>
<li>Gert Smolka</li>
</ul>
</body>
</html>
53 changes: 53 additions & 0 deletions extra/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
title: Regular Language Representations in Coq
lang: en
header-includes:
- |
<style type="text/css"> body {font-family: Arial, Helvetica; margin-left: 5em; font-size: large;} </style>
<style type="text/css"> h1 {margin-left: 0em; padding: 0px; text-align: center} </style>
<style type="text/css"> h2 {margin-left: 0em; padding: 0px; color: #580909} </style>
<style type="text/css"> h3 {margin-left: 1em; padding: 0px; color: #C05001;} </style>
<style type="text/css"> body { width: 1100px; margin-left: 30px; }</style>
---

<div style="text-align:left"><img src="https://github.githubassets.com/images/modules/logos_page/Octocat.png" height="25" style="border:0px">
[View the project on GitHub](https://github.com/coq-community/reglang)
<img src="https://github.githubassets.com/images/modules/logos_page/Octocat.png" height="25" style="border:0px"></div>

## About

Welcome to the Regular Language Representations in Coq project website! This project is part of [coq-community](https://github.com/coq-community/manifesto).

This library provides definitions and verified translations between
different representations of regular languages: various forms of
automata (deterministic, nondeterministic, one-way, two-way),
regular expressions, and the logic WS1S. It also contains various
decidability results and closure properties of regular languages.

This is an open source project, licensed under CeCILL-B.

## Get the code

The current stable release of Regular Language Representations in Coq can be [downloaded from GitHub](https://github.com/coq-community/reglang/releases).

## Documentation

The coqdoc presentations of releases can be browsed online:

- [v1.1](docs/v1.1/coqdoc/toc.html)

Other related publications, if any, are listed below.

- [Regular Language Representations in the Constructive Type Theory of Coq](https://hal.archives-ouvertes.fr/hal-01832031/document) doi:[10.1007/s10817-018-9460-x](https://doi.org/10.1007/s10817-018-9460-x)

## Help and contact

- Report issues on [GitHub](https://github.com/coq-community/reglang/issues)
- Chat with us on [Gitter](https://gitter.im/coq-community/Lobby)
- Discuss with us on Coq's [Discourse](https://coq.discourse.group) forum

## Authors and contributors

- Christian Doczkal
- Jan-Oliver Kaiser
- Gert Smolka
3 changes: 2 additions & 1 deletion meta.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ shortname: reglang
organization: coq-community
community: true
travis: true
coqdoc: true
doi: 10.1007/s10817-018-9460-x

synopsis: >-
Expand Down Expand Up @@ -81,7 +82,7 @@ documentation: |-
To generate HTML documentation, run `make coqdoc` and point your browser at `docs/coqdoc/toc.html`.
Pregenerated HTML documentation can be found at: https://www.ps.uni-saarland.de/extras/RLR-Coq
See also the pregenerated HTML documentation for the [latest release](https://coq-community.github.io/reglang/docs/latest/coqdoc/toc.html).
## File Contents
Expand Down

0 comments on commit 1b9becb

Please sign in to comment.