diff --git a/.github/ISSUE_TEMPLATE/2-docs.yml b/.github/ISSUE_TEMPLATE/2-docs.yml index a892af1c1..a5de65eac 100644 --- a/.github/ISSUE_TEMPLATE/2-docs.yml +++ b/.github/ISSUE_TEMPLATE/2-docs.yml @@ -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" @@ -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 diff --git a/README.md b/README.md index bb6b2911e..a6732338e 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,19 @@ -[Scenic Logo](https://scenic-lang.org/) +[Scenic Logo](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) or start a conversation on our [community forum](https://forum.scenic-lang.org/). diff --git a/docs/index.rst b/docs/index.rst index 2ef4a5881..cc5fbcd76 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -16,7 +16,7 @@ Our :doc:`publications ` page lists additional papers using Scenic Old code can likely be easily ported; you can also install older releases if necessary from `GitHub `__. -If you have any problems using Scenic, please submit an issue to `our GitHub repository `_ or contact Daniel at dfremont@ucsc.edu. +If you have any problems using Scenic, please submit an issue to `our GitHub repository `_ or ask a question on `our community forum `_. Table of Contents ================= diff --git a/docs/quickstart.rst b/docs/quickstart.rst index 34fe517d0..aeabe83c3 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -171,3 +171,5 @@ Depending on what you'd like to do with Scenic, different parts of the documenta * If you want to control Scenic from Python rather than using the command-line tool (for example if you want to collect data from the generated scenarios), see :doc:`api`. * If you want to add a feature to the language or otherwise need to understand Scenic's inner workings, see our pages on :doc:`developing` and :ref:`internals`. + +If you can't find something in the documentation, or have any question about Scenic, feel free to post on our `community forum `_. diff --git a/examples/carla/NHTSA_Scenarios/README.md b/examples/carla/NHTSA_Scenarios/README.md index b5eb7435f..3aaa8748e 100644 --- a/examples/carla/NHTSA_Scenarios/README.md +++ b/examples/carla/NHTSA_Scenarios/README.md @@ -4,7 +4,7 @@ This folder includes a library of Scenic programs written for use with the CARLA For questions and concerns, please contact Francis Indaheng at or post an issue to this repo. -*Note:* These scenarios require [VerifAI](https://verifai.readthedocs.io/) to be installed, since they use VerifAI's Halton sampler by default (the sampler type can be configured as explained [here](https://scenic-lang.readthedocs.io/en/latest/modules/scenic.core.external_params.html): for example, you can add `--param verifaiSamplerType random` when running Scenic to use random sampling instead). +*Note:* These scenarios require [VerifAI](https://verifai.readthedocs.io/) to be installed, since they use VerifAI's Halton sampler by default (the sampler type can be configured as explained [here](https://docs.scenic-lang.org/en/latest/modules/scenic.core.external_params.html): for example, you can add `--param verifaiSamplerType random` when running Scenic to use random sampling instead). ## Intersection diff --git a/examples/webots/README.md b/examples/webots/README.md index bcf3b0255..114279468 100644 --- a/examples/webots/README.md +++ b/examples/webots/README.md @@ -2,6 +2,6 @@ This folder contains example Scenic scenarios for use with the Webots robotics simulator. -In the **generic** folder we provide several Webots worlds (``.wbt`` files inside ``webots_data/worlds``) demonstrating scenarios with Scenic's [generic Webots interface](https://scenic-lang.readthedocs.io/en/latest/modules/scenic.simulators.webots.simulator.html). To run these, either install Scenic in the version of Python used by Webots or launch Webots from inside a virtual environment where Scenic is installed (the latter works as of Webots R2023a) then open one of the ``.wbt`` files. Starting the simulation will automatically start Scenic and repeatedly generate scenarios. +In the **generic** folder we provide several Webots worlds (``.wbt`` files inside ``webots_data/worlds``) demonstrating scenarios with Scenic's [generic Webots interface](https://docs.scenic-lang.org/en/latest/modules/scenic.simulators.webots.simulator.html). To run these, either install Scenic in the version of Python used by Webots or launch Webots from inside a virtual environment where Scenic is installed (the latter works as of Webots R2023a) then open one of the ``.wbt`` files. Starting the simulation will automatically start Scenic and repeatedly generate scenarios. __Licensing Note:__ The ``mars.wbt`` file is a modified version of the [Sojourner Rover example](https://cyberbotics.com/doc/guide/sojourner#sojourner-wbt) included in Webots. The original was written by Nicolas Uebelhart and is copyrighted by Cyberbotics Ltd. under the [Webots asset license](https://cyberbotics.com/webots_assets_license). Under the terms of that license, the modified version remains property of Cyberbotics; however, all other files in this directory are covered by the Scenic license. In particular, please feel free to model your own supervisor implementation on ``generic/webots_data/controllers/scenic_supervisor.py``. diff --git a/pyproject.toml b/pyproject.toml index 3dc615e32..8ef20b1c1 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -86,7 +86,7 @@ dev = [ [project.urls] Homepage = "https://scenic-lang.org/" Repository = "https://github.com/BerkeleyLearnVerify/Scenic" -Documentation = "https://scenic-lang.readthedocs.io" +Documentation = "https://docs.scenic-lang.org" [project.scripts] scenic = 'scenic.__main__:dummy' diff --git a/src/scenic/syntax/pygment.py b/src/scenic/syntax/pygment.py index b93ac5ce2..8af6d5630 100644 --- a/src/scenic/syntax/pygment.py +++ b/src/scenic/syntax/pygment.py @@ -353,7 +353,7 @@ class ScenicLexer(BetterPythonLexer): filenames = ["*.scenic"] alias_filenames = ["*.sc"] mimetypes = ["application/x-scenic", "text/x-scenic"] - url = "https://scenic-lang.readthedocs.org/" + url = "https://scenic-lang.org/" uni_name = PythonLexer.uni_name obj_name = rf"(?:(ego)|({uni_name}))"