remove outdated documentation related to compiler schema.

Also remove content related to buildtest schemadocs since this doesn't exist. We also update the bash completion script
buildtesters · Dec 28, 2023 · b825256 · b825256
1 parent 3366c5a
commit b825256
Show file tree

Hide file tree

Showing 8 changed files with 9 additions and 394 deletions.
diff --git a/bash_completion.sh b/bash_completion.sh
@@ -556,7 +556,7 @@ _buildtest ()
       COMPREPLY=( $( compgen -W "${opts}" -- "${cur}" ) )
       ;;
     # options with only --help
-    debugreport|info|docs|schemadocs|tutorial-examples)
+    debugreport|info|docs|tutorial-examples)
       local opts="-h --help"
       COMPREPLY=( $( compgen -W "${opts}" -- "${cur}" ) )
       ;;

diff --git a/docs/buildspec_tutorial.rst b/docs/buildspec_tutorial.rst
@@ -7,7 +7,6 @@ Buildspec Tutorial
    :maxdepth: 1
 
    buildspecs/buildspec_overview
-   buildspecs/compiler
    buildspecs/spack
    buildspecs/e4s_testsuite
 
@@ -21,7 +20,7 @@ Tutorials Setup
 
 .. note::
 
-    The tutorial setup is required if you want to run buildspecs using the the :ref:`compiler <compiler_schema>` and :ref:`spack <buildtest_spack_integration>` schema.
+    The tutorial setup is required if you want to run buildspecs using the :ref:`spack <buildtest_spack_integration>` schema.
 
 
 To get started for this tutorial, you will need `docker <https://docs.docker.com/get-docker/>`_ on your machine to pull the container. At NERSC,

diff --git a/docs/buildspecs/compiler.rst b/docs/buildspecs/compiler.rst
diff --git a/docs/configuring_buildtest/compilers.rst b/docs/configuring_buildtest/compilers.rst
@@ -5,10 +5,8 @@ Defining Compilers
 
 buildtest provides a mechanism to declare compilers in your configuration file, this
 is defined in ``compilers`` top-level section. The compilers should reflect compilers
-installed at your site. The compilers are used if you are writing a buildspec
-with :ref:`compiler schema <compiler_schema>` that needs to reference a particular compiler.
-The compilers are declared within scope of a system since we assume compilers will vary across
-different HPC clusters.
+installed at your site. The compilers are declared within scope of a system since we assume
+compilers will vary across different HPC clusters.
 
 Compiler Declaration
 ---------------------

diff --git a/docs/contributing/schema.rst b/docs/contributing/schema.rst
@@ -1,18 +1,6 @@
 Contributing to Schemas
 ==========================
 
-Schema Docs
-------------
-
-Schema Documentation are hosted on branch `gh-pages <https://github.com/buildtesters/buildtest/tree/gh-pages>`_
-which is hosted via GitHub Pages at https://buildtesters.github.io/buildtest/.
-
-There is an automated workflow `jsonschema2md <https://github.com/buildtesters/buildtest/blob/devel/.github/workflows/jsonschemadocs.yml>`_
-which publishes schemas, documentation and examples. If you want to edit top-level page
-`README.md <https://github.com/buildtesters/buildtest/blob/gh-pages/README.md>`_ please
-send a pull-request to `gh-pages` branch.
-
-
 Adding a new schema
 ----------------------
 
@@ -81,8 +69,7 @@ references definition ``string_or_list``::
       "$ref": "#/definitions/string_or_list"
     },
 
-The tags field is used in other schemas like **compiler.schema.json**
-and **script.schema.json**. In this example we declare **tags** field and
+The tags field is used in other schemas like **script.schema.json**. In this example we declare **tags** field and
 reference tags anchor from definitions.schema.json::
 
     "tags": {

diff --git a/docs/features.rst b/docs/features.rst
@@ -80,9 +80,6 @@ To access `buildtest docs <https://buildtest.readthedocs.io/>`_ you can run::
 
   buildtest docs
 
-To access `schema docs <https://buildtesters.github.io/buildtest>`_ you can run::
-
-  buildtest schemadocs
 
 Enabling colored output for table entries
 -------------------------------------------------------------

diff --git a/docs/schema_examples.rst b/docs/schema_examples.rst
@@ -86,18 +86,6 @@ This is the script schema used for writing scripts (bash, csh, sh, zsh, tcsh, py
     .. literalinclude:: ../buildtest/schemas/script.schema.json
        :language: json
 
-
-Compiler Schema
-~~~~~~~~~~~~~~~~
-
-This is the compiler schema used for validating buildspecs that define test using ``type: compiler``.
-This schema is used for compiling a single source code. For more details see :ref:`compiler_schema`
-
-.. dropdown:: compiler.schema.json
-
-    .. literalinclude:: ../buildtest/schemas/compiler.schema.json
-       :language: json
-
 Spack Schema
 ~~~~~~~~~~~~~~
 

diff --git a/docs/writing_buildspecs/global.rst b/docs/writing_buildspecs/global.rst
@@ -3,9 +3,10 @@
 Global Schema
 ==============
 
-The global schema is validated with for all buildspecs and this schema defines the top-level structure of the buildspec file.
-Please refer to `global schema documentation <https://buildtesters.github.io/buildtest/pages/schemadocs/global.html>`_ that
-provides a summary .
+The global schema file (`global.schema.json <https://raw.githubusercontent.com/buildtesters/buildtest/devel/buildtest/schemas/global.schema.json>`_)
+is validated with for all buildspecs and this schema defines the top-level structure of the buildspec file. In particular this will validate
+the ``buildspecs`` keyword which is a JSON object that defines one or more tests (buildspecs). Each test must be unique name.
+
 
 Schema Definition
 ------------------