Skip to content

Commit

Permalink
Merge branch 'main' of github.com:BerkeleyLearnVerify/Scenic
Browse files Browse the repository at this point in the history
  • Loading branch information
abanuelo committed Jun 25, 2024
2 parents 437463a + d7679fb commit ef3f6a0
Show file tree
Hide file tree
Showing 19 changed files with 172 additions and 25 deletions.
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/2-docs.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: Documentation
description: Report an issue or enhancement related to https://scenic-lang.readthedocs.io/
description: Report an issue or enhancement related to https://docs.scenic-lang.org/
labels:
- "type: documentation"
- "status: triage"
Expand All @@ -14,9 +14,9 @@ body:
attributes:
label: Describe the doc issue or enhancement
description: >
Please provide a clear and concise description of what content in https://scenic-lang.readthedocs.io/ has an issue or needs enhancement.
Please provide a clear and concise description of what content in https://docs.scenic-lang.org/ has an issue or needs enhancement.
placeholder: |
Link to location in the docs: https://scenic-lang.readthedocs.io/
Link to location in the docs: https://docs.scenic-lang.org/
validations:
required: true

Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: Questions
url: https://forms.gle/uUhQNuPzQrvvBFJX9
about: Send your questions via Google Form
url: https://forum.scenic-lang.org/
about: Post your questions on our community forum
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
# Scenic
[<img src="https://docs.scenic-lang.org/en/latest/_static/logo-full.svg" alt="Scenic Logo" height="100">](https://scenic-lang.org/)

[![Documentation Status](https://readthedocs.org/projects/scenic-lang/badge/?version=latest)](https://scenic-lang.readthedocs.io/en/latest/?badge=latest)
[![Documentation Status](https://readthedocs.org/projects/scenic-lang/badge/?version=latest)](https://docs.scenic-lang.org/en/latest/?badge=latest)
[![Tests Status](https://github.com/BerkeleyLearnVerify/Scenic/actions/workflows/run-tests.yml/badge.svg)](https://github.com/BerkeleyLearnVerify/Scenic/actions/workflows/run-tests.yml)
[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)

A compiler and scenario generator for Scenic, a domain-specific probabilistic programming language for modeling the environments of cyber-physical systems.
Please see the [documentation](https://scenic-lang.readthedocs.io/) for installation instructions, as well as tutorials and other information about the Scenic language, its implementation, and its interfaces to various simulators.
Please see the [documentation](https://docs.scenic-lang.org/) for installation instructions, as well as tutorials and other information about the Scenic language, its implementation, and its interfaces to various simulators.

For an overview of the language and some of its applications, see our [2022 journal paper](https://link.springer.com/article/10.1007/s10994-021-06120-5) on Scenic 2, which extends our [PLDI 2019 paper](https://arxiv.org/abs/1809.09310) on Scenic 1.
The new syntax and features of Scenic 3 are described in our [CAV 2023 paper](https://arxiv.org/abs/2307.03325).
Our [Publications](https://scenic-lang.readthedocs.io/en/latest/publications.html) page lists additional relevant publications.
Our [Publications](https://docs.scenic-lang.org/en/latest/publications.html) page lists additional relevant publications.

Scenic was initially designed and implemented by Daniel J. Fremont, Tommaso Dreossi, Shromona Ghosh, Xiangyu Yue, Alberto L. Sangiovanni-Vincentelli, and Sanjit A. Seshia.
Additionally, Edward Kim made major contributions to Scenic 2, and Eric Vin, Shun Kashiwa, Matthew Rhea, and Ellen Kalvan to Scenic 3.
Please see our [Credits](https://scenic-lang.readthedocs.io/en/latest/credits.html) page for details and more contributors.
Please see our [Credits](https://docs.scenic-lang.org/en/latest/credits.html) page for details and more contributors.

If you have any problems using Scenic, please submit an issue to [our GitHub repository](https://github.com/BerkeleyLearnVerify/Scenic).
If you have any problems using Scenic, please submit an issue to [our GitHub repository](https://github.com/BerkeleyLearnVerify/Scenic) or start a conversation on our [community forum](https://forum.scenic-lang.org/).

The repository is organized as follows:

Expand Down
6 changes: 6 additions & 0 deletions docs/_static/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@ pre {tab-size: 4;}
.wy-table-responsive table td, .wy-table-responsive table th {white-space: normal;}
/* Increase maximum body width to support 100-character lines */
.wy-nav-content {max-width:900px;}
/* Make SVG logo render at the correct size */
.wy-side-nav-search .wy-dropdown > a img.logo, .wy-side-nav-search > a img.logo {
width: 100%;
}
/* Modify background color behind logo to make it more readable */
.wy-side-nav-search {background-color:#48ac92}
/* Shrink the sidebar to 270 pixels wide */
.wy-tray-container li, .wy-menu-vertical, .wy-side-nav-search, .wy-nav-side,
.rst-versions {width:270px;}
Expand Down
7 changes: 7 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,13 @@
"custom.css",
]

html_logo = "images/logo-full.svg"
html_favicon = "images/favicon.ico"

html_theme_options = {
"logo_only": True,
}

# -- Generate lists of keywords for the language reference -------------------

import itertools
Expand Down
Binary file added docs/images/favicon.ico
Binary file not shown.
Loading

0 comments on commit ef3f6a0

Please sign in to comment.