Porting latest modification from master into stable (#57)

* Addition od X-band configurations * Fix issue 55 --------- Co-authored-by: SimonaRighini <[email protected]> Co-authored-by: Marco Buttu <[email protected]>
discos · Jul 3, 2023 · c01fe95 · c01fe95
1 parent cfe39f0
commit c01fe95
Show file tree

Hide file tree

Showing 5 changed files with 47 additions and 147 deletions.
diff --git a/conf.py b/conf.py
@@ -1,92 +1,57 @@
-# -*- coding: utf-8 -*-
-
 import sys, os, time
 
-# General configuration
-# ---------------------
 sys.path.append(os.path.abspath('ext'))
 
-extensions = [
-    'discos',
-    'sphinx.ext.autodoc',
-    'sphinx.ext.intersphinx',
-    'sphinx.ext.todo',
-    'sphinx.ext.mathjax',
-    'sphinx.ext.viewcode',
-]
-mathjax_path = 'http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
-
-# Add any paths that contain templates here, relative to this directory.
-templates_path = ['theme/templates']
-
-# The suffix of source filenames.
-source_suffix = '.rst'
-
-# The master toctree document.
-master_doc = 'index'
-
-# General substitutions.
 project = 'DISCOS Control Software'
 copyright = '2006-%s, DISCOS Control Software Team' % time.strftime('%Y')
-
-# We should get this information from somewhere in the sources
 version = '0.6'
-# The full version, including alpha/beta/rc tags.
 release = '0.6'
 
 # If true, sectionauthor and moduleauthor directives will be shown in the
 # output. They are ignored by default.
 show_authors = True
 
-# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'discos.DISCOSStyle'
 
-# Require Sphinx 1.2 for build.
-needs_sphinx = '1.2'
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+extensions = [
+    'discos',
+    'sphinx.ext.autodoc',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.todo',
+    'sphinx.ext.mathjax',
+    'sphinx.ext.viewcode',
+]
+
+templates_path = ['theme/templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+source_suffix = '.rst'
+root_doc = 'index'
 
+mathjax_path = 'http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'
 
-# Options for HTML output
-# -----------------------
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-# Use the custom shinx_rtd_theme (readthedocs.org)
-on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
 html_theme_path = ['theme']
-if not on_rtd:  # only import and set the theme if we're building docs locally
-    import sphinx_rtd_theme
-    html_theme = 'sphinx_rtd_theme'
-    html_theme_path.append(sphinx_rtd_theme.get_html_theme_path())
-    # Override default css to get a larger width for local build                 
-    def setup(app):                                                              
-        # app.add_javascript("custom.js")                                         
-        app.add_stylesheet('pygments.css')                                
-else:                                                                            
-    # Override default css to get a larger width for ReadTheDoc build            
-    html_context = {                                                             
-        'css_files': [                                                           
-            'https://media.readthedocs.org/css/sphinx_rtd_theme.css',            
-            'https://media.readthedocs.org/css/readthedocs-doc-embed.css',       
-            '_static/pygments.css',                                       
-        ],                                                                       
-    }
+html_theme = 'sphinx_rtd_theme'
+html_static_path = ['theme/static/']
 
 # Short title used e.g. for <title> HTML tags.
 html_short_title = 'DISCOS documentation'
 
-# Path to find HTML templates.
-templates_path = ['theme/templates']
-# Additional static files.
-html_static_path = ['theme/static/']
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'discos.DISCOSStyle'
 
 # Custom sidebar templates, filenames relative to this file.
 #html_sidebars = {}
 
 # Custom sidebar templates, maps document names to template names.
 #html_sidebars = {}
 
-# Output file base name for HTML help builder.
-htmlhelp_basename = 'nuraghe'
-
 # Split the index
 # html_split_index = False
 
@@ -104,10 +69,11 @@ def setup(app):
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, document class [howto/manual]).
 latex_documents = [
-  ('index', 
-   'nuraghe-doc.tex', 
-   u'DISCOS Documentation', 
-   u'DISCOS CS team', 'manual'),
+    (
+     'index',
+     'DISCOS Documentation',
+     'DISCOS CS team', 'manual'
+    ),
 ]
 
 pdf_break_level = 0

diff --git a/ext/discos.py b/ext/discos.py
@@ -109,4 +109,4 @@ class DISCOSLexer(RegexLexer):
     }
 
 def setup(sphinx):
-    sphinx.add_lexer("discos", DISCOSLexer())
+    sphinx.add_lexer("discos", DISCOSLexer)
diff --git a/requirements.txt b/requirements.txt
@@ -1,2 +1,4 @@
-sphinx==1.8.2
-docutils==0.17.1
+docutils==0.18.1
+sphinx==6.2.1
+sphinx_rtd_theme==1.2.2
+sphinxcontrib-jquery==4.1
diff --git a/user/medicina/Backend.rst b/user/medicina/Backend.rst
@@ -132,6 +132,16 @@ and use one of the following commands in operatorInput:
    This configuration is for the usage of the Chigh-band receiver, 
    in full-Stokes mode (LCP and RCP spectraand Stokes parameters). 
 
+.. describe:: > initialize=SX00 
+
+   This configuration is for the usage of the X-band receiver, 
+   in spectral mode only (total intensity spectra). 
+
+.. describe:: > initialize=SX00S 
+
+   This configuration is for the usage of the X-band receiver, 
+   in full-Stokes mode (LCP and RCP spectra and Stokes parameters). 
+
 .. describe:: > initialize=SK00 
 
    This configuration is for the usage of the K-band reference feed, 
@@ -142,7 +152,9 @@ and use one of the following commands in operatorInput:
    This configuration is for the usage of the K-band reference feed, 
    in full-Stokes mode (LCP and RCP spectra and Stokes parameters). 
 
-
+All of the above configurations set, by default, Sardara's bandwidth to 1500 MHz
+and the focus selector (TPB) bandwidth to 730 MHz for X band and 1250 MHz for 
+all the other receivers.  
 Ideally, configuration details can be changed using the ``setSection`` command:: 
 
     > setSection=[sect],[startFreq],[bw],[feed],[mode],[sampleRate],[bins]

diff --git a/user/srt/source/Troubleshooting.rst b/user/srt/source/Troubleshooting.rst