Merge pull request #171 from esc/rename-project-in-docs

Rename project in docs

docs/source/conf.py

@@ -6,10 +6,10 @@
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
-project = 'numba-rvsdg'
+project = 'numba-scfg'
 copyright = '2023, Numba Developers'
 author = 'Numba Developers'
-release = '0.0.6-dev0'
+release = '0.0.8-dev0'
 
 import os
 import sys

docs/source/contributing.rst

@@ -2,7 +2,7 @@
 Contributing Guidelines
 =======================
 
-numba-rvsdg originated to fulfill the needs of the Numba_ project.
+numba-scfg originated to fulfill the needs of the Numba_ project.
 It is maintained mostly by the Numba team. We tend to prioritize
 the needs and constraints of Numba over other conflicting desires.
 
@@ -21,7 +21,7 @@ Communication methods
 Forum
 -----
 
-numba-rvsdg uses the Numba Discourse as a forum for longer running threads such as
+numba-scfg uses the Numba Discourse as a forum for longer running threads such as
 design discussions and roadmap planning. There are various categories available
 and it can be reached at: `numba.discourse.group
 <https://numba.discourse.group/>`_.
@@ -32,15 +32,15 @@ Bug reports
 -----------
 
 We use the
-`Github issue tracker <https://github.com/numba/numba-rvsdg/issues>`_
+`Github issue tracker <https://github.com/numba/numba-scfg/issues>`_
 to track both bug reports and feature requests. If you report an
 issue, please include:
 
 * What you are trying to do.
 
 * Your operating system.
 
-* What version of numba-rvsdg you are running.
+* What version of numba-scfg you are running.
 
 * A description of the problem---for example, the full error
   traceback or the unexpected results you are getting.
@@ -55,7 +55,7 @@ Pull requests
 
 To contribute code:
 
-#. Fork our `Github repository <https://github.com/numba/numba-rvsdg>`_.
+#. Fork our `Github repository <https://github.com/numba/numba-scfg>`_.
 
 #. Create a branch representing your work.
 
@@ -78,9 +78,9 @@ Coding conventions
 Documentation
 =============
 
-This numba-rvsdg documentation is built using Sphinx and maintained
+This numba-scfg documentation is built using Sphinx and maintained
 in the ``docs`` directory inside the
-`numba-rvsdg repository <https://github.com/numba/numba-rvsdg>`_.
+`numba-scfg repository <https://github.com/numba/numba-scfg>`_.
 
 #. Edit the source files under ``docs/source/``.
 

docs/source/index.rst

@@ -1,16 +1,16 @@
-.. numba-rvsdg documentation master file, created by
+.. numba-scfg documentation master file, created by
    sphinx-quickstart on Tue May 16 17:22:12 2023.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
 ===========
-numba-rvsdg
+numba-scfg
 ===========
 
-:emphasis:`Numba compatible RVSDG (Regionalized Value State Dependence Graph) utilities.`
+:emphasis:`Numba compatible SCFG (Structured Control Flow Graph) utilities.`
 
-This repository contains Numba_ compatible utilities for working with RVSDGs 
-(Regionalized Value State Dependency Graphs). RVSDGs are a type of Intermediary 
+This repository contains Numba_ compatible utilities for working with SCFGs 
+(Structured Control Flow Graphs). SCFGs are a type of Intermediary 
 Representation (IR) suitable for regularizing Python bytecode within Numba_.
 
 The code in this repository is an implementation of the CFG restructuring 

docs/source/user_guide/install.rst

@@ -8,8 +8,8 @@ Setting up the conda development environment
 
 The conda environment and all necessary dependencies can be setup using the following commands::
 
-        conda env create -n numba-rvsdg python=3.11
-        conda activate numba-rvsdg
+        conda env create -n numba-scfg python=3.11
+        conda activate numba-scfg
         pip install pyyaml python-graphviz
 
 .. note::
@@ -18,14 +18,14 @@ The conda environment and all necessary dependencies can be setup using the foll
 Installation using pip
 ----------------------
 
-Users can install numba-rvsdg using pip as follows::
+Users can install numba-scfg using pip as follows::
 
-        pip install numba-rvsdg
+        pip install numba-scfg
 
-Alternatively, after setting up the appropriate environment, Users can also manually install numba-rvsdg using it's git repository.
+Alternatively, after setting up the appropriate environment, Users can also manually install numba-scfg using it's git repository.
 A development version of the package can be installed as follows::
 
-        git clone https://github.com/numba/numba-rvsdg.git
-        cd numba-rvsdg/
-        conda activate numba-rvsdg # or the enviroment that you've setup
+        git clone https://github.com/numba/numba-scfg.git
+        cd numba-scfg/
+        conda activate numba-scfg # or the enviroment that you've setup
         pip install -e .[dev]