Home
last modified time | relevance | path

Searched +full:sphinx +full:- +full:build (Results 1 – 12 of 12) sorted by relevance

/petsc/src/binding/petsc4py/
H A Dmakefile1 -include ../../../petscdir.mk
3 default: build
4 default: opt=--inplace
12 # ----
14 .PHONY: config build test
17 build: target
18 ${PYTHON} setup.py build ${opt}
21 test-%:
22 ${MPIEXEC} -n $* ${VALGRIND} ${PYTHON} ${PWD}/test/runtests.py ${opt}
28 -${RM} src/${package}/${MODULE}.c
[all …]
H A DCHANGES.rst12 - Update to PETSc 3.24 release.
14 - Support (opt-in via setting the environment variable
21 - Update to PETSc 3.23 release.
26 - Update to PETSc 3.22 release.
31 - Update to PETSc 3.21 release.
36 - Update to PETSc 3.20 release.
37 - Update Cython build, require ``Cython >= 3.0.0``.
42 - Update to PETSc 3.19 release.
43 - Expose ``PetscDevice`` and ``PetscDeviceContext`` API as
49 - Update to PETSc 3.18 release.
[all …]
/petsc/doc/developers/
H A Ddocumentation.md9 - Good documentation should be like a bonsai tree: alive, on display, frequently tended, and as sma…
10 - Wrong, irrelevant, or confusing documentation is worse than no documentation.
14 ## Documentation with Sphinx
16 …Sphinx](https://www.sphinx-doc.org/en/master/) to build our web pages and documentation. Most cont…
18 [These slides](https://gitlab.com/psanan/petsc-sphinx-slides) contain an overview of Sphinx and how…
24 We use a [Python 3 virtual environment](https://docs.python.org/3/tutorial/venv.html) to build the …
60 ### Sphinx Documentation Guidelines argument
62 Refer to Sphinx's [own documentation](https://https://www.sphinx-doc.org) for general information o…
64 - Use the [literalinclude directive](https://www.sphinx-doc.org/en/master/usage/restructuredtext/di…
68 :start-at: PetscErrorCode PetscError(
[all …]
H A Dstyle.md7 terminology *subclass*, *implementation*, or *type* [^footnote-1] to refer to a
27 - have an appended `_Private` (for example, `StashValues_Private`)
29 - have an appended `_Subtype` (for example, `MatMultSeq_AIJ`).
44 06. Each application-usable function begins with the name of the class
49 07. Functions that PETSc provides as defaults for user-providable
54 the word “set” or “get”, for example, `-ksp_gmres_restart`.
64 12. Use the abbreviation NaN for Not-a-Number.
71 is a signed 32-bit or 64-bit `int` depending on the `./configure` option
72 `--with-64-bit-indices`. There is the possibility of integer overflow with the
73 32-bit version.
[all …]
/petsc/doc/
H A Dmakefile1 # Initially generated with sphinx-quickstart
6 SPHINXBUILD ?= sphinx-build
13 …-@echo " make sphinxhtml - build the HTML website inside a created Python virtual environment (v…
16 # @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS)
21 @$(SPHINXBUILD) -b linkcheck "$(SOURCEDIR)" "$(LINKCHECKDIR)" $(SPHINXOPTS)
26 …cd .. ; ${RM} -rf petsc-doc-env; python3 -m venv petsc-doc-env ; source petsc-doc-env/bin/activate…
29 -@${RM} -rf _build __pycache__
32 git clone https://gitlab.com/petsc/images.git -b main-2 --depth=1 images
34 website-deploy: images
35 $(SPHINXBUILD) -b dirhtml "$(SOURCEDIR)" "$(BUILDDIR)" -T -E -j auto $(SPHINXOPTS)
[all …]
H A Dconf.py1 # Configuration file for the Sphinx documentation builder.
4 # http://www.sphinx-doc.org/en/master/config
27 print("-----------------------------------------------------------------------------")
32 print("-----------------------------------------------------------------------------")
36 # -- Project information -------------------------------------------------------
39 copyright = '1991-%d, UChicago Argonne, LLC and the PETSc Development Team' % datetime.date.today()…
46 petsc_release_flag = re.search(' PETSC_VERSION_RELEASE[ ]*([0-9]*)',buf).group(1)
47 major_version = re.search(' PETSC_VERSION_MAJOR[ ]*([0-9]*)',buf).group(1)
48 minor_version = re.search(' PETSC_VERSION_MINOR[ ]*([0-9]*)',buf).group(1)
49 subminor_version = re.search(' PETSC_VERSION_SUBMINOR[ ]*([0-9]*)',buf).group(1)
[all …]
H A Dbuild_man_index.py36 # https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/page-toc.html
50 fd.write("---\n")
52 fd.write("---\n")
57 fd.write('- [](%s)\n' % name)
63 fd.write("---\n")
65 fd.write("---\n")
67 fd.write('- [](%s)\n' % name)
82 fd.write("---\n")
84 fd.write("---\n")
91 fd.write("- [%s](%s)\n" % (name, path_name))
[all …]
/petsc/src/binding/petsc4py/docs/source/
H A DMakefile1 # Minimal makefile for Sphinx documentation
7 SPHINXBUILD ?= sphinx-build
13 @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
17 # Catch-all target: route all unknown targets to Sphinx using the new
20 @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
H A Dconf.py1 # Configuration file for the Sphinx documentation builder.
3 # For the full list of built-in configuration values, see the documentation:
4 # https://www.sphinx-doc.org/en/master/usage/configuration.html
6 # -- Path setup --------------------------------------------------------------
23 from sphinx import __version__ as sphinx_version
24 from sphinx.ext.napoleon.docstring import NumpyDocstring
30 # FIXME: allow building from build?
32 # -- Project information -----------------------------------------------------
33 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
56 version_re = re.compile(rf'#define\s+{release_macro}\s+([-]*\d+)')
[all …]
/petsc/doc/ext/
H A Dhtml5_petsc.py1 """ Sphinx extension for custom HTML processing for PETSc docs """
11 from sphinx import version_info as sphinx_version_info
12 from sphinx.writers.html5 import HTML5Translator
13 from sphinx.application import Sphinx
20 def setup(app: Sphinx) -> None: argument
23 app.connect('builder-inited', _setup_translators)
27 def _check_version(app: Sphinx) -> None: argument
31 print('A custom extension duplicates code from Sphinx %s ' % (sphinx_version_info_source,),
36 def _setup_translators(app: Sphinx) -> None: argument
37 """ Use a mixin strategy to add to the Sphinx HTML translator without overriding
[all …]
/petsc/doc/developers/contributing/
H A Dsubmittingmr.md8 - The default **target** branch is `main`; if your branch started from `release`, select that as th…
9 - If the merge request resolves an outstanding [issue](https://gitlab.com/petsc/petsc/issues),
10 …ttern](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#default-closing-pattern)
11 …cription to automatically have the issue closed when the MR is merged [^closing-patterns-release] .
15 - Select appropriate [labels](https://gitlab.com/petsc/petsc/-/labels) including a {any}`workflow l…
16 - Assign yourself to the MR.
17 - Select reviewers for the MR; clicking on `> Approval Rules` will list appropriate reviewers.
18 - If the branch started from `release` select the `milestone` of `Vxx.yy-release-fixes`
19 - For changes only to documentation, add the `docs-only` label, which will
20 trigger a modified pipeline to build a preview of the documentation automatically.
[all …]
/petsc/
H A D.gitlab-ci.yml2 # stage-1 take only a few minutes; they do not run the full test suite or external packages.
4 # stage-2 runs on MCS systems and may take 10 to 15 minutes. They run the full test suite but with …
6 # stage-3 runs on MCS systems and may take an hour or more. They run the full test suite and heavil…
8 # The stage-(n) tests are only started if all of the stage-(n-1) tests run without error
13 - stage-1
14 - stage-2
15 - stage-3
16 - stage-4
19 GIT_CLEAN_FLAGS: -ffdxq
21 BASE_EXTRA_OPTIONS: -nox -nox_warning -malloc_dump
[all …]