Merge pull request #2672 from SasView/sasdata-29-documentation

Include SasData documentation in SasView
SasView · Dec 5, 2023 · 647a580 · 647a580
2 parents 077f21f + 0dd4a8b
commit 647a580
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 225 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -181,12 +181,13 @@ jobs:
         run: |
           python -m pip install sphinx
 
-      - name: Build sasmodels and bumps docs
+      - name: Build sasmodels, sasdata, and bumps docs
         if: ${{ matrix.docs }}
         run: |
           make -C ../bumps/doc html || true
           mkdir -p ~/.sasmodels/compiled_models
           make -j4 -C ../sasmodels/doc html || true
+          make -C ../sasdata/docs html || true
 
       - name: Build sasview docs
         if: ${{ matrix.docs }}

diff --git a/docs/sphinx-docs/build_sphinx.py b/docs/sphinx-docs/build_sphinx.py
@@ -57,6 +57,15 @@
     "index.rst", "install.rst", "intro.rst",
 ]
 
+# sasdata paths
+SASDATA_ROOT = joinpath(SASVIEW_ROOT, "..", "sasdata")
+SASDATA_DOCS = joinpath(SASDATA_ROOT, "docs")
+SASDATA_BUILD = joinpath(SASDATA_ROOT, "build", "lib")
+SASDATA_DEV_SOURCE = joinpath(SASDATA_DOCS, "source", "dev")
+SASDATA_DEV_TARGET = joinpath(SPHINX_SOURCE, "dev", "sasdata-dev")
+SASDATA_GUIDE_SOURCE = joinpath(SASDATA_DOCS, "source", "user")
+SASDATA_GUIDE_TARGET = joinpath(SPHINX_SOURCE, "user", "data")
+
 # bumps paths
 BUMPS_DOCS = joinpath(SASVIEW_ROOT, "..", "bumps", "doc")
 BUMPS_SOURCE = joinpath(BUMPS_DOCS, "guide")
@@ -154,6 +163,15 @@ def retrieve_user_docs():
         inplace_change(joinpath(catdir, filename), "../../model/", "/user/models/")
 
 
+def retrieve_sasdata_docs():
+    """
+        Copies select files from the bumps documentation into fitting perspective
+    """
+    print("=== Sasdata Docs ===")
+    copy_tree(SASDATA_DEV_SOURCE, SASDATA_DEV_TARGET)
+    copy_tree(SASDATA_GUIDE_SOURCE, SASDATA_GUIDE_TARGET)
+
+
 def retrieve_bumps_docs():
     """
     Copies select files from the bumps documentation into fitting perspective
@@ -268,6 +286,7 @@ def rebuild():
     setup_source_temp()
     retrieve_user_docs()
     retrieve_bumps_docs()
+    retrieve_sasdata_docs()
     apidoc()
     build()
     if find_executable('latex'):

diff --git a/docs/sphinx-docs/source/dev/dev.rst b/docs/sphinx-docs/source/dev/dev.rst
@@ -12,6 +12,7 @@ Contents
    SasView API <sasview-api/modules>
    sasmodels overview <sasmodels-dev/index>
    sasmodels API <sasmodels-api/modules>
+   sasdata overview <sasdata-dev/dev>
    OpenGL subsystem <gl/opengl.rst>
 
 Indices and Search

diff --git a/docs/sphinx-docs/source/user/working.rst b/docs/sphinx-docs/source/user/working.rst
@@ -6,13 +6,13 @@ Working with SasView
 .. toctree::
    :maxdepth: 1
 
-   Data Formats <qtgui/MainWindow/data_formats_help>
+   Data Formats <data/data/data_formats_help>
 
    Loading Data <qtgui/MainWindow/data_explorer_help>
 
    Plotting Data/Models <qtgui/MainWindow/graph_help>
 
-   Test Data <example_data/testdata_help>
+   Example Data <example_data/testdata_help>
 
    Tutorials <tutorial>
 

diff --git a/src/sas/qtgui/MainWindow/media/data_formats_help.rst b/src/sas/qtgui/MainWindow/media/data_formats_help.rst