From 2aa5983c28774a3386e16dcd0a41580eddac75dc Mon Sep 17 00:00:00 2001 From: Silke Schomann Date: Wed, 9 Oct 2024 13:21:16 +0100 Subject: [PATCH 01/12] Temporarily run sphinx on push --- .github/workflows/online_doc_update.yml | 8 ++++---- docs/source/conf.py | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/workflows/online_doc_update.yml b/.github/workflows/online_doc_update.yml index d679e0f67..30f6d5333 100644 --- a/.github/workflows/online_doc_update.yml +++ b/.github/workflows/online_doc_update.yml @@ -1,9 +1,9 @@ name: MSlice online documentation update -on: - push: - branches: - - main +on: push +# push: +# branches: +# - main jobs: build: diff --git a/docs/source/conf.py b/docs/source/conf.py index 4a887bc0c..8138c968a 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -72,7 +72,7 @@ # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = None +#language = None # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: From 0b85206a7b8823062b61b6bc6597c6deed573daa Mon Sep 17 00:00:00 2001 From: Silke Schomann Date: Wed, 9 Oct 2024 13:34:06 +0100 Subject: [PATCH 02/12] Modify construction of source path --- docs/source/conf.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 8138c968a..d123d8227 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -17,7 +17,8 @@ # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. -sys.path.insert(0, os.path.abspath('../../src')) +#sys.path.insert(0, os.path.abspath('../../src')) +sys.path.insert(0, os.path.abspath(os.path.join("../..", "src"))) from mslice import version_info From df69527ade5e3ddbf609394dd80b3b95732e3f54 Mon Sep 17 00:00:00 2001 From: Silke Schomann Date: Wed, 9 Oct 2024 13:49:10 +0100 Subject: [PATCH 03/12] Check that directories are ok --- src/mslice/__init__.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/mslice/__init__.py b/src/mslice/__init__.py index 216a468c1..96c66c8af 100644 --- a/src/mslice/__init__.py +++ b/src/mslice/__init__.py @@ -5,7 +5,7 @@ A PyQt-based version of the MSlice (http://mslice.isis.rl.ac.uk) program based on Mantid (http://www.mantidproject.org). """ - +print("version") version_info = (2, 9, 1) __version__ = '.'.join(map(str, version_info)) __project_url__ = 'https://github.com/mantidproject/mslice' From bdb947a4d8b1b79d9f4ae7355ab968ac91ff40ec Mon Sep 17 00:00:00 2001 From: Silke Schomann Date: Wed, 9 Oct 2024 13:55:58 +0100 Subject: [PATCH 04/12] Print sys.path --- docs/source/conf.py | 2 +- src/mslice/__init__.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index d123d8227..7b950fbfa 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -19,7 +19,7 @@ # documentation root, use os.path.abspath to make it absolute, like shown here. #sys.path.insert(0, os.path.abspath('../../src')) sys.path.insert(0, os.path.abspath(os.path.join("../..", "src"))) - +print(sys.path) from mslice import version_info # -- General configuration ------------------------------------------------ diff --git a/src/mslice/__init__.py b/src/mslice/__init__.py index 96c66c8af..216a468c1 100644 --- a/src/mslice/__init__.py +++ b/src/mslice/__init__.py @@ -5,7 +5,7 @@ A PyQt-based version of the MSlice (http://mslice.isis.rl.ac.uk) program based on Mantid (http://www.mantidproject.org). """ -print("version") + version_info = (2, 9, 1) __version__ = '.'.join(map(str, version_info)) __project_url__ = 'https://github.com/mantidproject/mslice' From 874986edd4fe36dae1ea11095557ab25e768354e Mon Sep 17 00:00:00 2001 From: Silke Schomann Date: Wed, 9 Oct 2024 14:25:59 +0100 Subject: [PATCH 05/12] Modify directory for mslice --- docs/source/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 7b950fbfa..1d791c322 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -18,8 +18,8 @@ # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. #sys.path.insert(0, os.path.abspath('../../src')) -sys.path.insert(0, os.path.abspath(os.path.join("../..", "src"))) -print(sys.path) +sys.path.insert(0, os.path.abspath(os.path.join("../../src", "mslice"))) + from mslice import version_info # -- General configuration ------------------------------------------------ From a9ed9bbaceb742554b9f450a642612805c999b13 Mon Sep 17 00:00:00 2001 From: Silke Schomann Date: Wed, 9 Oct 2024 15:30:58 +0100 Subject: [PATCH 06/12] Revert modified directory --- docs/source/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 1d791c322..7b950fbfa 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -18,8 +18,8 @@ # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. #sys.path.insert(0, os.path.abspath('../../src')) -sys.path.insert(0, os.path.abspath(os.path.join("../../src", "mslice"))) - +sys.path.insert(0, os.path.abspath(os.path.join("../..", "src"))) +print(sys.path) from mslice import version_info # -- General configuration ------------------------------------------------ From a77e59b7dcd7bf5d1cd68fde2fdaca49f4766e8d Mon Sep 17 00:00:00 2001 From: Silke Schomann Date: Thu, 10 Oct 2024 09:16:39 +0100 Subject: [PATCH 07/12] Set write permission --- .github/workflows/online_doc_update.yml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/.github/workflows/online_doc_update.yml b/.github/workflows/online_doc_update.yml index 30f6d5333..fb111ac37 100644 --- a/.github/workflows/online_doc_update.yml +++ b/.github/workflows/online_doc_update.yml @@ -8,6 +8,11 @@ on: push jobs: build: runs-on: ubuntu-latest + environment: + name: github-pages + permissions: + pages: write + id-token: write steps: - name: Checkout uses: actions/checkout@v4 From 27f0f3c5c960209952d8348bdc7ec4a82c625964 Mon Sep 17 00:00:00 2001 From: Silke Schomann Date: Thu, 10 Oct 2024 09:34:47 +0100 Subject: [PATCH 08/12] New sphinx workflow --- .github/workflows/online_doc_update.yml | 25 +++++-------------------- docs/source/conf.py | 2 +- 2 files changed, 6 insertions(+), 21 deletions(-) diff --git a/.github/workflows/online_doc_update.yml b/.github/workflows/online_doc_update.yml index fb111ac37..52d60cb5c 100644 --- a/.github/workflows/online_doc_update.yml +++ b/.github/workflows/online_doc_update.yml @@ -6,29 +6,14 @@ on: push # - main jobs: - build: + pages: runs-on: ubuntu-latest - environment: - name: github-pages - permissions: - pages: write - id-token: write steps: - - name: Checkout - uses: actions/checkout@v4 - with: - fetch-depth: 0 - - name: Update dependencies - run: | - sudo apt-get update -qq - sudo apt-get install texlive-latex-base texlive-latex-recommended \ - texlive-fonts-recommended texlive-latex-extra dvipng - - name: Build and Commit + - id: deployment uses: sphinx-notes/pages@v3 with: - documentation_path: docs/source - - name: Push changes - uses: ad-m/github-push-action@v0.6.0 + publish: false + - uses: peaceiris/actions-gh-pages@v3 with: github_token: ${{ secrets.GITHUB_TOKEN }} - branch: gh-pages + publish_dir: ${{ steps.deployment.outputs.artifact }} \ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py index 7b950fbfa..d123d8227 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -19,7 +19,7 @@ # documentation root, use os.path.abspath to make it absolute, like shown here. #sys.path.insert(0, os.path.abspath('../../src')) sys.path.insert(0, os.path.abspath(os.path.join("../..", "src"))) -print(sys.path) + from mslice import version_info # -- General configuration ------------------------------------------------ From e8a8d95dd127a99a1740c3f2d71bd85595cd08e2 Mon Sep 17 00:00:00 2001 From: Silke Schomann Date: Thu, 10 Oct 2024 09:51:22 +0100 Subject: [PATCH 09/12] Moved docs from source folder --- docs/Makefile | 192 ------------- docs/{source => }/cli.rst | 0 docs/{source => }/conf.py | 144 +++++----- docs/{source => }/cutting.rst | 0 .../images/cli/generate_script_menu.png | Bin .../images/cutting/cut_options.png | Bin .../{source => }/images/cutting/cut_panel.png | Bin .../images/cutting/intensity_chi_cut.png | Bin .../images/cutting/powder_lines.png | Bin .../images/math_ref/rebin_cuts.png | Bin .../images/math_ref/rebin_grids.svg | 0 .../images/quickstart/calc_proj.png | Bin docs/{source => }/images/quickstart/cut_q.png | Bin .../images/quickstart/data_tab.png | Bin .../images/quickstart/en_units_combo.png | Bin .../images/quickstart/en_units_conversion.png | Bin .../images/quickstart/en_units_defaults.png | Bin .../images/quickstart/interactive_cuts.png | Bin docs/{source => }/images/quickstart/keep.png | Bin .../images/quickstart/load_tab.png | Bin .../quickstart/mantid_interfaces_menu.png | Bin .../images/quickstart/multi_cut.png | Bin .../images/quickstart/slice_intensity.png | Bin .../images/quickstart/subtract_dialog.png | Bin .../images/quickstart/subtract_slice.png | Bin .../images/slicing/calculate_projection.png | Bin .../images/slicing/intensity_chi.png | Bin .../images/slicing/powder_lines.png | Bin docs/{source => }/images/slicing/recoil.png | Bin .../images/slicing/slice_options.png | Bin docs/{source => }/index.rst | 0 docs/make.bat | 263 ------------------ docs/{source => }/math_ref.rst | 0 docs/{source => }/quickstart.rst | 0 docs/{source => }/slicing.rst | 0 docs/source/_static/.gitkeep | 0 docs/source/_templates/.gitkeep | 0 37 files changed, 72 insertions(+), 527 deletions(-) delete mode 100644 docs/Makefile rename docs/{source => }/cli.rst (100%) rename docs/{source => }/conf.py (83%) rename docs/{source => }/cutting.rst (100%) rename docs/{source => }/images/cli/generate_script_menu.png (100%) rename docs/{source => }/images/cutting/cut_options.png (100%) rename docs/{source => }/images/cutting/cut_panel.png (100%) rename docs/{source => }/images/cutting/intensity_chi_cut.png (100%) rename docs/{source => }/images/cutting/powder_lines.png (100%) rename docs/{source => }/images/math_ref/rebin_cuts.png (100%) rename docs/{source => }/images/math_ref/rebin_grids.svg (100%) rename docs/{source => }/images/quickstart/calc_proj.png (100%) rename docs/{source => }/images/quickstart/cut_q.png (100%) rename docs/{source => }/images/quickstart/data_tab.png (100%) rename docs/{source => }/images/quickstart/en_units_combo.png (100%) rename docs/{source => }/images/quickstart/en_units_conversion.png (100%) rename docs/{source => }/images/quickstart/en_units_defaults.png (100%) rename docs/{source => }/images/quickstart/interactive_cuts.png (100%) rename docs/{source => }/images/quickstart/keep.png (100%) rename docs/{source => }/images/quickstart/load_tab.png (100%) rename docs/{source => }/images/quickstart/mantid_interfaces_menu.png (100%) rename docs/{source => }/images/quickstart/multi_cut.png (100%) rename docs/{source => }/images/quickstart/slice_intensity.png (100%) rename docs/{source => }/images/quickstart/subtract_dialog.png (100%) rename docs/{source => }/images/quickstart/subtract_slice.png (100%) rename docs/{source => }/images/slicing/calculate_projection.png (100%) rename docs/{source => }/images/slicing/intensity_chi.png (100%) rename docs/{source => }/images/slicing/powder_lines.png (100%) rename docs/{source => }/images/slicing/recoil.png (100%) rename docs/{source => }/images/slicing/slice_options.png (100%) rename docs/{source => }/index.rst (100%) delete mode 100644 docs/make.bat rename docs/{source => }/math_ref.rst (100%) rename docs/{source => }/quickstart.rst (100%) rename docs/{source => }/slicing.rst (100%) delete mode 100644 docs/source/_static/.gitkeep delete mode 100644 docs/source/_templates/.gitkeep diff --git a/docs/Makefile b/docs/Makefile deleted file mode 100644 index a61caa50d..000000000 --- a/docs/Makefile +++ /dev/null @@ -1,192 +0,0 @@ -# Makefile for Sphinx documentation -# - -# You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = sphinx-build -PAPER = -BUILDDIR = build - -# User-friendly check for sphinx-build -ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) -$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) -endif - -# Internal variables. -PAPEROPT_a4 = -D latex_paper_size=a4 -PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source -# the i18n builder cannot share the environment and doctrees with the others -I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source - -.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext - -help: - @echo "Please use \`make ' where is one of" - @echo " html to make standalone HTML files" - @echo " dirhtml to make HTML files named index.html in directories" - @echo " singlehtml to make a single large HTML file" - @echo " pickle to make pickle files" - @echo " json to make JSON files" - @echo " htmlhelp to make HTML files and a HTML help project" - @echo " qthelp to make HTML files and a qthelp project" - @echo " applehelp to make an Apple Help Book" - @echo " devhelp to make HTML files and a Devhelp project" - @echo " epub to make an epub" - @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" - @echo " latexpdf to make LaTeX files and run them through pdflatex" - @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" - @echo " text to make text files" - @echo " man to make manual pages" - @echo " texinfo to make Texinfo files" - @echo " info to make Texinfo files and run them through makeinfo" - @echo " gettext to make PO message catalogs" - @echo " changes to make an overview of all changed/added/deprecated items" - @echo " xml to make Docutils-native XML files" - @echo " pseudoxml to make pseudoxml-XML files for display purposes" - @echo " linkcheck to check all external links for integrity" - @echo " doctest to run all doctests embedded in the documentation (if enabled)" - @echo " coverage to run coverage check of the documentation (if enabled)" - -clean: - rm -rf $(BUILDDIR)/* - -html: - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." - -dirhtml: - $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." - -singlehtml: - $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml - @echo - @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." - -pickle: - $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle - @echo - @echo "Build finished; now you can process the pickle files." - -json: - $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json - @echo - @echo "Build finished; now you can process the JSON files." - -htmlhelp: - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp - @echo - @echo "Build finished; now you can run HTML Help Workshop with the" \ - ".hhp project file in $(BUILDDIR)/htmlhelp." - -qthelp: - $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp - @echo - @echo "Build finished; now you can run "qcollectiongenerator" with the" \ - ".qhcp project file in $(BUILDDIR)/qthelp, like this:" - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/MSlice.qhcp" - @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/MSlice.qhc" - -applehelp: - $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp - @echo - @echo "Build finished. The help book is in $(BUILDDIR)/applehelp." - @echo "N.B. You won't be able to view it unless you put it in" \ - "~/Library/Documentation/Help or install it in your application" \ - "bundle." - -devhelp: - $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp - @echo - @echo "Build finished." - @echo "To view the help file:" - @echo "# mkdir -p $$HOME/.local/share/devhelp/MSlice" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/MSlice" - @echo "# devhelp" - -epub: - $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub - @echo - @echo "Build finished. The epub file is in $(BUILDDIR)/epub." - -latex: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo - @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." - @echo "Run \`make' in that directory to run these through (pdf)latex" \ - "(use \`make latexpdf' here to do that automatically)." - -latexpdf: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through pdflatex..." - $(MAKE) -C $(BUILDDIR)/latex all-pdf - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -latexpdfja: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through platex and dvipdfmx..." - $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -text: - $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text - @echo - @echo "Build finished. The text files are in $(BUILDDIR)/text." - -man: - $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man - @echo - @echo "Build finished. The manual pages are in $(BUILDDIR)/man." - -texinfo: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo - @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." - @echo "Run \`make' in that directory to run these through makeinfo" \ - "(use \`make info' here to do that automatically)." - -info: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo "Running Texinfo files through makeinfo..." - make -C $(BUILDDIR)/texinfo info - @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." - -gettext: - $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale - @echo - @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." - -changes: - $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes - @echo - @echo "The overview file is in $(BUILDDIR)/changes." - -linkcheck: - $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck - @echo - @echo "Link check complete; look for any errors in the above output " \ - "or in $(BUILDDIR)/linkcheck/output.txt." - -doctest: - $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest - @echo "Testing of doctests in the sources finished, look at the " \ - "results in $(BUILDDIR)/doctest/output.txt." - -coverage: - $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage - @echo "Testing of coverage in the sources finished, look at the " \ - "results in $(BUILDDIR)/coverage/python.txt." - -xml: - $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml - @echo - @echo "Build finished. The XML files are in $(BUILDDIR)/xml." - -pseudoxml: - $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml - @echo - @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." diff --git a/docs/source/cli.rst b/docs/cli.rst similarity index 100% rename from docs/source/cli.rst rename to docs/cli.rst diff --git a/docs/source/conf.py b/docs/conf.py similarity index 83% rename from docs/source/conf.py rename to docs/conf.py index d123d8227..91ae299ad 100644 --- a/docs/source/conf.py +++ b/docs/conf.py @@ -17,15 +17,15 @@ # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. -#sys.path.insert(0, os.path.abspath('../../src')) +# sys.path.insert(0, os.path.abspath('../../src')) sys.path.insert(0, os.path.abspath(os.path.join("../..", "src"))) -from mslice import version_info +from mslice import version_info # noqa: E402 # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. -#needs_sphinx = '1.0' +# needs_sphinx = '1.0' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom @@ -49,7 +49,7 @@ source_suffix = '.rst' # The encoding of source files. -#source_encoding = 'utf-8-sig' +# source_encoding = 'utf-8-sig' # The master toctree document. master_doc = 'index' @@ -73,13 +73,13 @@ # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -#language = None +# language = None # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: -#today = '' +# today = '' # Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' +# today_fmt = '%B %d, %Y' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. @@ -87,27 +87,27 @@ # The reST default role (used for this markup: `text`) to use for all # documents. -#default_role = None +# default_role = None # If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True +# add_function_parentheses = True # If true, the current module name will be prepended to all description # unit titles (such as .. function::). -#add_module_names = True +# add_module_names = True # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. -#show_authors = False +# show_authors = False # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' # A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] +# modindex_common_prefix = [] # If true, keep warnings as "system message" paragraphs in the built documents. -#keep_warnings = False +# keep_warnings = False # -- Options for todo -------------------------------------------------- @@ -118,7 +118,7 @@ # -- Options for pngmath -------------------------------------------------- # Load the preview package into latex -pngmath_latex_preamble=r'\usepackage[active]{preview}' +pngmath_latex_preamble = r'\usepackage[active]{preview}' # Ensures that the vertical alignment of equations is correct. # See http://sphinx-doc.org/ext/math.html#confval-pngmath_use_preview @@ -133,26 +133,26 @@ # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. -#html_theme_options = {} +# html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] +# html_theme_path = [] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". -#html_title = None +# html_title = None # A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None +# html_short_title = None # The name of an image file (relative to this directory) to place at the top # of the sidebar. -#html_logo = None +# html_logo = None # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. -#html_favicon = None +# html_favicon = None # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, @@ -162,62 +162,62 @@ # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied # directly to the root of the documentation. -#html_extra_path = [] +# html_extra_path = [] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. -#html_last_updated_fmt = '%b %d, %Y' +# html_last_updated_fmt = '%b %d, %Y' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. -#html_use_smartypants = True +# html_use_smartypants = True # Custom sidebar templates, maps document names to template names. -#html_sidebars = {} +# html_sidebars = {} # Additional templates that should be rendered to pages, maps page names to # template names. -#html_additional_pages = {} +# html_additional_pages = {} # If false, no module index is generated. -#html_domain_indices = True +# html_domain_indices = True # If false, no index is generated. -#html_use_index = True +# html_use_index = True # If true, the index is split into individual pages for each letter. -#html_split_index = False +# html_split_index = False # If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True +# html_show_sourcelink = True # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -#html_show_sphinx = True +# html_show_sphinx = True # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -#html_show_copyright = True +# html_show_copyright = True # If true, an OpenSearch description file will be output, and all pages will # contain a tag referring to it. The value of this option must be the # base URL from which the finished HTML is served. -#html_use_opensearch = '' +# html_use_opensearch = '' # This is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = None +# html_file_suffix = None # Language to be used for generating the HTML full-text search index. # Sphinx supports the following languages: # 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' # 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' -#html_search_language = 'en' +# html_search_language = 'en' # A dictionary with options for the search language support, empty by default. # Now only 'ja' uses this config value -#html_search_options = {'type': 'default'} +# html_search_options = {'type': 'default'} # The name of a javascript file (relative to the configuration directory) that # implements a search results scorer. If empty, the default will be used. -#html_search_scorer = 'scorer.js' +# html_search_scorer = 'scorer.js' # Output file base name for HTML help builder. htmlhelp_basename = 'MSlicedoc' @@ -225,17 +225,17 @@ # -- Options for LaTeX output --------------------------------------------- latex_elements = { -# The paper size ('letterpaper' or 'a4paper'). -#'papersize': 'letterpaper', + # The paper size ('letterpaper' or 'a4paper'). + # 'papersize': 'letterpaper', -# The font size ('10pt', '11pt' or '12pt'). -#'pointsize': '10pt', + # The font size ('10pt', '11pt' or '12pt'). + # 'pointsize': '10pt', -# Additional stuff for the LaTeX preamble. -#'preamble': '', + # Additional stuff for the LaTeX preamble. + # 'preamble': '', -# Latex figure (float) alignment -#'figure_align': 'htbp', + # Latex figure (float) alignment + # 'figure_align': 'htbp', } # Grouping the document tree into LaTeX files. List of tuples @@ -248,23 +248,23 @@ # The name of an image file (relative to this directory) to place at the top of # the title page. -#latex_logo = None +# latex_logo = None # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. -#latex_use_parts = False +# latex_use_parts = False # If true, show page references after internal links. -#latex_show_pagerefs = False +# latex_show_pagerefs = False # If true, show URL addresses after external links. -#latex_show_urls = False +# latex_show_urls = False # Documents to append as an appendix to all manuals. -#latex_appendices = [] +# latex_appendices = [] # If false, no module index is generated. -#latex_domain_indices = True +# latex_domain_indices = True # -- Options for manual page output --------------------------------------- @@ -277,7 +277,7 @@ ] # If true, show URL addresses after external links. -#man_show_urls = False +# man_show_urls = False # -- Options for Texinfo output ------------------------------------------- @@ -292,16 +292,16 @@ ] # Documents to append as an appendix to all manuals. -#texinfo_appendices = [] +# texinfo_appendices = [] # If false, no module index is generated. -#texinfo_domain_indices = True +# texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. -#texinfo_show_urls = 'footnote' +# texinfo_show_urls = 'footnote' # If true, do not generate a @detailmenu in the "Top" node's menu. -#texinfo_no_detailmenu = False +# texinfo_no_detailmenu = False # -- Options for Epub output ---------------------------------------------- @@ -313,65 +313,65 @@ epub_copyright = copyright # The basename for the epub file. It defaults to the project name. -#epub_basename = project +# epub_basename = project # The HTML theme for the epub output. Since the default themes are not optimized # for small screen space, using the same theme for HTML and epub output is # usually not wise. This defaults to 'epub', a theme designed to save visual # space. -#epub_theme = 'epub' +# epub_theme = 'epub' # The language of the text. It defaults to the language option # or 'en' if the language is not set. -#epub_language = '' +# epub_language = '' # The scheme of the identifier. Typical schemes are ISBN or URL. -#epub_scheme = '' +# epub_scheme = '' # The unique identifier of the text. This can be a ISBN number # or the project homepage. -#epub_identifier = '' +# epub_identifier = '' # A unique identification for the text. -#epub_uid = '' +# epub_uid = '' # A tuple containing the cover image and cover page html template filenames. -#epub_cover = () +# epub_cover = () # A sequence of (type, uri, title) tuples for the guide element of content.opf. -#epub_guide = () +# epub_guide = () # HTML files that should be inserted before the pages created by sphinx. # The format is a list of tuples containing the path and title. -#epub_pre_files = [] +# epub_pre_files = [] # HTML files shat should be inserted after the pages created by sphinx. # The format is a list of tuples containing the path and title. -#epub_post_files = [] +# epub_post_files = [] # A list of files that should not be packed into the epub file. epub_exclude_files = ['search.html'] # The depth of the table of contents in toc.ncx. -#epub_tocdepth = 3 +# epub_tocdepth = 3 # Allow duplicate toc entries. -#epub_tocdup = True +# epub_tocdup = True # Choose between 'default' and 'includehidden'. -#epub_tocscope = 'default' +# epub_tocscope = 'default' # Fix unsupported image types using the Pillow. -#epub_fix_images = False +# epub_fix_images = False # Scale large images. -#epub_max_image_width = 0 +# epub_max_image_width = 0 # How to display URL addresses: 'footnote', 'no', or 'inline'. -#epub_show_urls = 'inline' +# epub_show_urls = 'inline' # If false, no index is generated. -#epub_use_index = True +# epub_use_index = True # Example configuration for intersphinx: refer to the Python standard library. diff --git a/docs/source/cutting.rst b/docs/cutting.rst similarity index 100% rename from docs/source/cutting.rst rename to docs/cutting.rst diff --git a/docs/source/images/cli/generate_script_menu.png b/docs/images/cli/generate_script_menu.png similarity index 100% rename from docs/source/images/cli/generate_script_menu.png rename to docs/images/cli/generate_script_menu.png diff --git a/docs/source/images/cutting/cut_options.png b/docs/images/cutting/cut_options.png similarity index 100% rename from docs/source/images/cutting/cut_options.png rename to docs/images/cutting/cut_options.png diff --git a/docs/source/images/cutting/cut_panel.png b/docs/images/cutting/cut_panel.png similarity index 100% rename from docs/source/images/cutting/cut_panel.png rename to docs/images/cutting/cut_panel.png diff --git a/docs/source/images/cutting/intensity_chi_cut.png b/docs/images/cutting/intensity_chi_cut.png similarity index 100% rename from docs/source/images/cutting/intensity_chi_cut.png rename to docs/images/cutting/intensity_chi_cut.png diff --git a/docs/source/images/cutting/powder_lines.png b/docs/images/cutting/powder_lines.png similarity index 100% rename from docs/source/images/cutting/powder_lines.png rename to docs/images/cutting/powder_lines.png diff --git a/docs/source/images/math_ref/rebin_cuts.png b/docs/images/math_ref/rebin_cuts.png similarity index 100% rename from docs/source/images/math_ref/rebin_cuts.png rename to docs/images/math_ref/rebin_cuts.png diff --git a/docs/source/images/math_ref/rebin_grids.svg b/docs/images/math_ref/rebin_grids.svg similarity index 100% rename from docs/source/images/math_ref/rebin_grids.svg rename to docs/images/math_ref/rebin_grids.svg diff --git a/docs/source/images/quickstart/calc_proj.png b/docs/images/quickstart/calc_proj.png similarity index 100% rename from docs/source/images/quickstart/calc_proj.png rename to docs/images/quickstart/calc_proj.png diff --git a/docs/source/images/quickstart/cut_q.png b/docs/images/quickstart/cut_q.png similarity index 100% rename from docs/source/images/quickstart/cut_q.png rename to docs/images/quickstart/cut_q.png diff --git a/docs/source/images/quickstart/data_tab.png b/docs/images/quickstart/data_tab.png similarity index 100% rename from docs/source/images/quickstart/data_tab.png rename to docs/images/quickstart/data_tab.png diff --git a/docs/source/images/quickstart/en_units_combo.png b/docs/images/quickstart/en_units_combo.png similarity index 100% rename from docs/source/images/quickstart/en_units_combo.png rename to docs/images/quickstart/en_units_combo.png diff --git a/docs/source/images/quickstart/en_units_conversion.png b/docs/images/quickstart/en_units_conversion.png similarity index 100% rename from docs/source/images/quickstart/en_units_conversion.png rename to docs/images/quickstart/en_units_conversion.png diff --git a/docs/source/images/quickstart/en_units_defaults.png b/docs/images/quickstart/en_units_defaults.png similarity index 100% rename from docs/source/images/quickstart/en_units_defaults.png rename to docs/images/quickstart/en_units_defaults.png diff --git a/docs/source/images/quickstart/interactive_cuts.png b/docs/images/quickstart/interactive_cuts.png similarity index 100% rename from docs/source/images/quickstart/interactive_cuts.png rename to docs/images/quickstart/interactive_cuts.png diff --git a/docs/source/images/quickstart/keep.png b/docs/images/quickstart/keep.png similarity index 100% rename from docs/source/images/quickstart/keep.png rename to docs/images/quickstart/keep.png diff --git a/docs/source/images/quickstart/load_tab.png b/docs/images/quickstart/load_tab.png similarity index 100% rename from docs/source/images/quickstart/load_tab.png rename to docs/images/quickstart/load_tab.png diff --git a/docs/source/images/quickstart/mantid_interfaces_menu.png b/docs/images/quickstart/mantid_interfaces_menu.png similarity index 100% rename from docs/source/images/quickstart/mantid_interfaces_menu.png rename to docs/images/quickstart/mantid_interfaces_menu.png diff --git a/docs/source/images/quickstart/multi_cut.png b/docs/images/quickstart/multi_cut.png similarity index 100% rename from docs/source/images/quickstart/multi_cut.png rename to docs/images/quickstart/multi_cut.png diff --git a/docs/source/images/quickstart/slice_intensity.png b/docs/images/quickstart/slice_intensity.png similarity index 100% rename from docs/source/images/quickstart/slice_intensity.png rename to docs/images/quickstart/slice_intensity.png diff --git a/docs/source/images/quickstart/subtract_dialog.png b/docs/images/quickstart/subtract_dialog.png similarity index 100% rename from docs/source/images/quickstart/subtract_dialog.png rename to docs/images/quickstart/subtract_dialog.png diff --git a/docs/source/images/quickstart/subtract_slice.png b/docs/images/quickstart/subtract_slice.png similarity index 100% rename from docs/source/images/quickstart/subtract_slice.png rename to docs/images/quickstart/subtract_slice.png diff --git a/docs/source/images/slicing/calculate_projection.png b/docs/images/slicing/calculate_projection.png similarity index 100% rename from docs/source/images/slicing/calculate_projection.png rename to docs/images/slicing/calculate_projection.png diff --git a/docs/source/images/slicing/intensity_chi.png b/docs/images/slicing/intensity_chi.png similarity index 100% rename from docs/source/images/slicing/intensity_chi.png rename to docs/images/slicing/intensity_chi.png diff --git a/docs/source/images/slicing/powder_lines.png b/docs/images/slicing/powder_lines.png similarity index 100% rename from docs/source/images/slicing/powder_lines.png rename to docs/images/slicing/powder_lines.png diff --git a/docs/source/images/slicing/recoil.png b/docs/images/slicing/recoil.png similarity index 100% rename from docs/source/images/slicing/recoil.png rename to docs/images/slicing/recoil.png diff --git a/docs/source/images/slicing/slice_options.png b/docs/images/slicing/slice_options.png similarity index 100% rename from docs/source/images/slicing/slice_options.png rename to docs/images/slicing/slice_options.png diff --git a/docs/source/index.rst b/docs/index.rst similarity index 100% rename from docs/source/index.rst rename to docs/index.rst diff --git a/docs/make.bat b/docs/make.bat deleted file mode 100644 index 440cdaff3..000000000 --- a/docs/make.bat +++ /dev/null @@ -1,263 +0,0 @@ -@ECHO OFF - -REM Command file for Sphinx documentation - -if "%SPHINXBUILD%" == "" ( - set SPHINXBUILD=sphinx-build -) -set BUILDDIR=build -set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% source -set I18NSPHINXOPTS=%SPHINXOPTS% source -if NOT "%PAPER%" == "" ( - set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% - set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS% -) - -if "%1" == "" goto help - -if "%1" == "help" ( - :help - echo.Please use `make ^` where ^ is one of - echo. html to make standalone HTML files - echo. dirhtml to make HTML files named index.html in directories - echo. singlehtml to make a single large HTML file - echo. pickle to make pickle files - echo. json to make JSON files - echo. htmlhelp to make HTML files and a HTML help project - echo. qthelp to make HTML files and a qthelp project - echo. devhelp to make HTML files and a Devhelp project - echo. epub to make an epub - echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter - echo. text to make text files - echo. man to make manual pages - echo. texinfo to make Texinfo files - echo. gettext to make PO message catalogs - echo. changes to make an overview over all changed/added/deprecated items - echo. xml to make Docutils-native XML files - echo. pseudoxml to make pseudoxml-XML files for display purposes - echo. linkcheck to check all external links for integrity - echo. doctest to run all doctests embedded in the documentation if enabled - echo. coverage to run coverage check of the documentation if enabled - goto end -) - -if "%1" == "clean" ( - for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i - del /q /s %BUILDDIR%\* - goto end -) - - -REM Check if sphinx-build is available and fallback to Python version if any -%SPHINXBUILD% 2> nul -if errorlevel 9009 goto sphinx_python -goto sphinx_ok - -:sphinx_python - -set SPHINXBUILD=python -m sphinx.__init__ -%SPHINXBUILD% 2> nul -if errorlevel 9009 ( - echo. - echo.The 'sphinx-build' command was not found. Make sure you have Sphinx - echo.installed, then set the SPHINXBUILD environment variable to point - echo.to the full path of the 'sphinx-build' executable. Alternatively you - echo.may add the Sphinx directory to PATH. - echo. - echo.If you don't have Sphinx installed, grab it from - echo.http://sphinx-doc.org/ - exit /b 1 -) - -:sphinx_ok - - -if "%1" == "html" ( - %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The HTML pages are in %BUILDDIR%/html. - goto end -) - -if "%1" == "dirhtml" ( - %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. - goto end -) - -if "%1" == "singlehtml" ( - %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. - goto end -) - -if "%1" == "pickle" ( - %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; now you can process the pickle files. - goto end -) - -if "%1" == "json" ( - %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; now you can process the JSON files. - goto end -) - -if "%1" == "htmlhelp" ( - %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; now you can run HTML Help Workshop with the ^ -.hhp project file in %BUILDDIR%/htmlhelp. - goto end -) - -if "%1" == "qthelp" ( - %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; now you can run "qcollectiongenerator" with the ^ -.qhcp project file in %BUILDDIR%/qthelp, like this: - echo.^> qcollectiongenerator %BUILDDIR%\qthelp\MSlice.qhcp - echo.To view the help file: - echo.^> assistant -collectionFile %BUILDDIR%\qthelp\MSlice.ghc - goto end -) - -if "%1" == "devhelp" ( - %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. - goto end -) - -if "%1" == "epub" ( - %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The epub file is in %BUILDDIR%/epub. - goto end -) - -if "%1" == "latex" ( - %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. - goto end -) - -if "%1" == "latexpdf" ( - %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex - cd %BUILDDIR%/latex - make all-pdf - cd %~dp0 - echo. - echo.Build finished; the PDF files are in %BUILDDIR%/latex. - goto end -) - -if "%1" == "latexpdfja" ( - %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex - cd %BUILDDIR%/latex - make all-pdf-ja - cd %~dp0 - echo. - echo.Build finished; the PDF files are in %BUILDDIR%/latex. - goto end -) - -if "%1" == "text" ( - %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The text files are in %BUILDDIR%/text. - goto end -) - -if "%1" == "man" ( - %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The manual pages are in %BUILDDIR%/man. - goto end -) - -if "%1" == "texinfo" ( - %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo. - goto end -) - -if "%1" == "gettext" ( - %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The message catalogs are in %BUILDDIR%/locale. - goto end -) - -if "%1" == "changes" ( - %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes - if errorlevel 1 exit /b 1 - echo. - echo.The overview file is in %BUILDDIR%/changes. - goto end -) - -if "%1" == "linkcheck" ( - %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck - if errorlevel 1 exit /b 1 - echo. - echo.Link check complete; look for any errors in the above output ^ -or in %BUILDDIR%/linkcheck/output.txt. - goto end -) - -if "%1" == "doctest" ( - %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest - if errorlevel 1 exit /b 1 - echo. - echo.Testing of doctests in the sources finished, look at the ^ -results in %BUILDDIR%/doctest/output.txt. - goto end -) - -if "%1" == "coverage" ( - %SPHINXBUILD% -b coverage %ALLSPHINXOPTS% %BUILDDIR%/coverage - if errorlevel 1 exit /b 1 - echo. - echo.Testing of coverage in the sources finished, look at the ^ -results in %BUILDDIR%/coverage/python.txt. - goto end -) - -if "%1" == "xml" ( - %SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The XML files are in %BUILDDIR%/xml. - goto end -) - -if "%1" == "pseudoxml" ( - %SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml. - goto end -) - -:end diff --git a/docs/source/math_ref.rst b/docs/math_ref.rst similarity index 100% rename from docs/source/math_ref.rst rename to docs/math_ref.rst diff --git a/docs/source/quickstart.rst b/docs/quickstart.rst similarity index 100% rename from docs/source/quickstart.rst rename to docs/quickstart.rst diff --git a/docs/source/slicing.rst b/docs/slicing.rst similarity index 100% rename from docs/source/slicing.rst rename to docs/slicing.rst diff --git a/docs/source/_static/.gitkeep b/docs/source/_static/.gitkeep deleted file mode 100644 index e69de29bb..000000000 diff --git a/docs/source/_templates/.gitkeep b/docs/source/_templates/.gitkeep deleted file mode 100644 index e69de29bb..000000000 From 0e7d7d37aa606b413abb738d64a87043db98435c Mon Sep 17 00:00:00 2001 From: Silke Schomann Date: Thu, 10 Oct 2024 10:06:57 +0100 Subject: [PATCH 10/12] Set version directly --- docs/conf.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 91ae299ad..33e55238c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -11,16 +11,16 @@ # # All configuration values have a default; values that are commented out # serve to show the default. -import os -import sys +# import os +# import sys # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. -# sys.path.insert(0, os.path.abspath('../../src')) -sys.path.insert(0, os.path.abspath(os.path.join("../..", "src"))) +# sys.path.insert(0, os.path.abspath(os.path.join("../..", "src"))) -from mslice import version_info # noqa: E402 +# from mslice import version_info # noqa: E402 +version_info = (2, 9, 1) # -- General configuration ------------------------------------------------ From 8221cce3c30d90e28f247897bbc444288ec098e1 Mon Sep 17 00:00:00 2001 From: Silke Schomann Date: Thu, 10 Oct 2024 10:16:28 +0100 Subject: [PATCH 11/12] Update peaceiris action version --- .github/workflows/online_doc_update.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/online_doc_update.yml b/.github/workflows/online_doc_update.yml index 52d60cb5c..047fc8b2e 100644 --- a/.github/workflows/online_doc_update.yml +++ b/.github/workflows/online_doc_update.yml @@ -13,7 +13,7 @@ jobs: uses: sphinx-notes/pages@v3 with: publish: false - - uses: peaceiris/actions-gh-pages@v3 + - uses: peaceiris/actions-gh-pages@v4 with: github_token: ${{ secrets.GITHUB_TOKEN }} publish_dir: ${{ steps.deployment.outputs.artifact }} \ No newline at end of file From c375848757436e21e1f6d979953b0d35b13eb4b3 Mon Sep 17 00:00:00 2001 From: Silke Schomann Date: Thu, 10 Oct 2024 10:23:12 +0100 Subject: [PATCH 12/12] Switch back to push to main --- .github/workflows/online_doc_update.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/online_doc_update.yml b/.github/workflows/online_doc_update.yml index 047fc8b2e..13602a79d 100644 --- a/.github/workflows/online_doc_update.yml +++ b/.github/workflows/online_doc_update.yml @@ -1,9 +1,9 @@ name: MSlice online documentation update -on: push -# push: -# branches: -# - main +on: + push: + branches: + - main jobs: pages: