Skip to content

GitLab

D
Docs
Commit 09b93864 authored by Emmanuel Promayon's avatar Emmanuel Promayon
Browse files
Options

Revert "Merge branch 'feature/use-sphinx-doc' into 'master'" 

This reverts commit 61e7c0c9, reversing
changes made to 46a35875.
parent 61e7c0c9
Pipeline #32776 passed with stages
      in 37 seconds
      Hide whitespace changes
      Inline Side-by-side
      Showing with 68 additions and 626 deletions
      .gitlab-ci.yml
      View file @ 09b93864
      image: alpine
      image: python:rc-alpine
      #python:alpine
      before_script:
      - pip install --upgrade pip
      - pip install markdown
      - pip install Pygments
      - pip install mkdocs
      #- pip install mkdocs-rtd-dropdown
      - pip install mkdocs-material
      #- pip install mkdocs-windmill
      #- pip install mkdocs-bootstrap386
      #- pip install mkdocs-bootswatch
      - pip install pymdown-extensions
      # Add your custom theme if not inside a theme_dir
      # (https://github.com/mkdocs/mkdocs/wiki/MkDocs-Themes)
      # - pip install mkdocs-material
      pages:
      script:
      - apk --no-cache add py2-pip python-dev
      - pip install sphinx recommonmark sphinx_rtd_theme
      - apk --no-cache add make
      - make html
      - mv build/html/ public/
      - mkdocs --version
      - mkdocs build
      - mv site public
      artifacts:
      paths:
      - public
      ......
      Makefile deleted 100644 → 0
      View file @ 61e7c0c9
      # Makefile for Sphinx documentation
      #
      # On debian (buster), you need first to install sphinx, rtd theme and recommonmark
      #
      # This should do the trick:
      # - sudo apt install python3-sphinx-rtd-theme python3-recommonmark
      #
      # You can set these variables from the command line.
      SPHINXOPTS =
      SPHINXBUILD = sphinx-build
      PAPER =
      BUILDDIR = build
      SOURCEDIR = src
      # Internal variables.
      PAPEROPT_a4 = -D latex_paper_size=a4
      PAPEROPT_letter = -D latex_paper_size=letter
      ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SOURCEDIR)
      # the i18n builder cannot share the environment and doctrees with the others
      I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SOURCEDIR)
      .PHONY: help
      help:
      @echo "Please use \`make <target>' where <target> 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 " epub3 to make an epub3"
      @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)"
      @echo " dummy to check syntax errors of document sources"
      .PHONY: clean
      clean:
      rm -rf $(BUILDDIR)/*
      .PHONY: html
      html:
      $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
      @echo
      @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
      .PHONY: dirhtml
      dirhtml:
      $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
      @echo
      @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
      .PHONY: singlehtml
      singlehtml:
      $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
      @echo
      @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
      .PHONY: pickle
      pickle:
      $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
      @echo
      @echo "Build finished; now you can process the pickle files."
      .PHONY: json
      json:
      $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
      @echo
      @echo "Build finished; now you can process the JSON files."
      .PHONY: htmlhelp
      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."
      .PHONY: qthelp
      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/SphinxExampleProject.qhcp"
      @echo "To view the help file:"
      @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/SphinxExampleProject.qhc"
      .PHONY: applehelp
      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."
      .PHONY: devhelp
      devhelp:
      $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
      @echo
      @echo "Build finished."
      @echo "To view the help file:"
      @echo "# mkdir -p $$HOME/.local/share/devhelp/SphinxExampleProject"
      @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/SphinxExampleProject"
      @echo "# devhelp"
      .PHONY: epub
      epub:
      $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
      @echo
      @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
      .PHONY: epub3
      epub3:
      $(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3
      @echo
      @echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3."
      .PHONY: latex
      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)."
      .PHONY: latexpdf
      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."
      .PHONY: latexpdfja
      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."
      .PHONY: text
      text:
      $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
      @echo
      @echo "Build finished. The text files are in $(BUILDDIR)/text."
      .PHONY: man
      man:
      $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
      @echo
      @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
      .PHONY: texinfo
      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)."
      .PHONY: info
      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."
      .PHONY: gettext
      gettext:
      $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
      @echo
      @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
      .PHONY: changes
      changes:
      $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
      @echo
      @echo "The overview file is in $(BUILDDIR)/changes."
      .PHONY: linkcheck
      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."
      .PHONY: doctest
      doctest:
      $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
      @echo "Testing of doctests in the sources finished, look at the " \
      "results in $(BUILDDIR)/doctest/output.txt."
      .PHONY: coverage
      coverage:
      $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
      @echo "Testing of coverage in the sources finished, look at the " \
      "results in $(BUILDDIR)/coverage/python.txt."
      .PHONY: xml
      xml:
      $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
      @echo
      @echo "Build finished. The XML files are in $(BUILDDIR)/xml."
      .PHONY: pseudoxml
      pseudoxml:
      $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
      @echo
      @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
      .PHONY: dummy
      dummy:
      $(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy
      @echo
      @echo "Build finished. Dummy builder generates no files."
      src/index.rst → docs/index.md
      View file @ 09b93864
      Welcome to the CamiTK wiki!
      -------------
      .. rst markdown: see https://github.com/ralsina/rst-cheatsheet/blob/master/rst-cheatsheet.rst
      # Welcome to the CamiTK wiki!
      <!-- Gitlab markdown: see https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/user/markdown.md#code-and-syntax-highlighting
      -->
      Here you will find information on how to develop with **CamiTK**.
      As a contributor, feel free to edit any page you may want, to update it or simply creating new ones to share your knowledge. Do not hesitate to check for some advices on how to edit the wiki ! This site remains your site, and any contribution will help a lot, saving a lot of time to the **CamiTK community** !
      Enjoy the `CamiTK wiki <https://camitk.gricad-pages.univ-grenoble-alpes.fr/Docs/>`_!
      .. toctree::
      :glob:
      :hidden:
      :caption: Table of Contents
      :name: mastertoc
      :maxdepth: 2
      Getting Started/Getting Started Guides/Install/index
      Getting Started/index
      Getting Started/CamiTK Overviews/CamiTK_architecture
      Getting Started/Examples and Tutorials/CamiTK_development_tutorial
      .. CamiTK Tools/*
      CamiTK Versions/*
      Highlighted Features/*
      Advanced Topics/*
      FAQ/*
      Enjoy the [**CamiTK wiki**](https://camitk.gricad-pages.univ-grenoble-alpes.fr/Docs/) !
      \ No newline at end of file
      mkdocs.yml 0 → 100644
      View file @ 09b93864
      site_name: CamiTK Community Edition Documentation
      site_url: https://camitk.gricad-pages.univ-grenoble-alpes.fr/Docs
      repo_url: https://gricad-gitlab.univ-grenoble-alpes.fr/CamiTK/Docs
      edit_uri: tree/master/docs/
      # Copyright
      copyright: 'Copyright &copy; 2001-2019 Univ. Grenoble Alpes, CNRS, TIMC-IMAG UMR 5525 (GMCAO)'
      theme:
      name: material #'yeti' 'amelia' 'bootstrap386' 'windmill' 'rtd-dropdown' 'material' 'bootstrap386'
      logo: 'assets/logo_CamiTK.png'
      favicon: 'assets/logo_CamiTK.png'
      feature:
      tabs: false
      markdown_extensions:
      - tables
      - admonition
      - codehilite:
      linenums: true
      guess_lang: true
      - toc:
      permalink: true
      - footnotes
      - pymdownx.superfences:
      preserve_tabs: true
      nav:
      #- Home: "index.md"
      #- Getting Started: "./Getting Started/"
      # - 'CEP Developer guide': "./Getting Started/index.md"
      # - 'CamiTK Overviews': "./Getting Started/CamiTK Overviews/CamiTK_architecture.md"
      # - 'Examples and Tutorials': "./Getting Started/Examples and Tutorials/CamiTK_development_tutorial.md"
      # - 'Getting Started Guides': "./Getting Started/Getting Started Guides/Install/index.md"
      #- CamiTK Tools: "./CamiTK Tools/"
      #- CamiTK Versions: "./CamiTK Versions/"
      #- Highlighted Features: "./Highlighted Features/" #Automatic-Tests.md"
      #- Advanced Topics: "./Advanced Topics/" #Image_Orientation_In_CamiTK.md"
      #- FAQ: "./FAQ/" #FAQ.md"
      src/conf.py deleted 100644 → 0
      View file @ 61e7c0c9
      # -*- coding: utf-8 -*-
      #
      # Sphinx Example Project documentation build configuration file, created by
      # sphinx-quickstart on Tue Oct 25 09:18:20 2016.
      #
      # This file is execfile()d with the current directory set to its
      # containing dir.
      #
      # Note that not all possible configuration values are present in this
      # autogenerated file.
      #
      # All configuration values have a default; values that are commented out
      # serve to show the default.
      # see https://recommonmark.readthedocs.io/en/latest/
      import recommonmark
      from recommonmark.transform import AutoStructify
      # To fix "TypeError: 'NoneType' object is not callable"
      # https://github.com/readthedocs/recommonmark/issues/93
      from recommonmark.states import DummyStateMachine
      # 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.
      #
      import os
      import sys
      sys.path.insert(0, os.path.abspath('.'))
      sys.path.insert(0, os.path.abspath('../src'))
      # -- General configuration ------------------------------------------------
      # If your documentation needs a minimal Sphinx version, state it here.
      #
      # needs_sphinx = '1.0'
      # once python3-recommonmark is installed
      # add the markdown files (see https://www.sphinx-doc.org/en/1.6/markdown.html)
      source_parsers = {
      '.md': 'recommonmark.parser.CommonMarkParser',
      }
      # Add any Sphinx extension module names here, as strings. They can be
      # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
      # ones.
      extensions = [
      'sphinx.ext.autodoc',
      'sphinx.ext.intersphinx',
      'sphinx.ext.mathjax',
      'sphinx.ext.ifconfig',
      #'recommonmark',
      # Auto-generate section labels.
      'sphinx.ext.autosectionlabel',
      ]
      # Prefix document path to section labels, otherwise autogenerated labels would look like 'heading'
      # rather than 'path/to/file:heading'
      #autosectionlabel_prefix_document = True
      # Add any paths that contain templates here, relative to this directory.
      templates_path = ['_templates']
      # The suffix(es) of source filenames.