Skip to content

Docs update#771

Merged
vlipovac merged 64 commits intodocsfrom
docs_update
Nov 25, 2022
Merged

Docs update#771
vlipovac merged 64 commits intodocsfrom
docs_update

Conversation

@vlipovac
Copy link
Contributor

@vlipovac vlipovac commented Nov 24, 2022 •
edited
Loading

Changes

  1. General update to the docs theme and to configurations.
  2. Updated example docs and How-To-Docstring according to remarks from this week's discussion.

Note:

Hyperlinking to type aliases is an open issue on Sphinx' side
sphinx-doc/sphinx#10785

jhabriel and others added 21 commits November 8, 2022 23:58
@jhabriel
ENH: Allow passing tol in domain_boundary_sides().
a78a7fd
@jhabriel
DOC: Improve sentence.
4de06f8
@keileg
BLD: Modified mypy.ini
0de2d26
@keileg
STY: Typing after update to Mypy 0.99
208fddf
@keileg
ENH: Cleanup of tags in FractureNetwork-Gmsh interface.
8cc4209 
Tags are now systematically taken as numerical in geometry processing
(this is convenient for splitting fractures etc.) and Enums in the
interface to Gmsh.

Also typing.
@keileg
BLD: Added py.typed file.
15c10ec 
Python and mypy seems to want this.
@keileg
STY: Import annotations from future.
68ae26d
@keileg
STY: isort
64431b9
@keileg @IvarStefansson
Update src/porepy/fracs/fracture_network_3d.py
2a2601c 
Co-authored-by: Ivar Stefansson <ivar.stefansson@uib.no>
@keileg
DOC: Improved documentation of FractureNetwork2d.
88f3059
@jhabriel
Merge branch 'develop' into feat_domain_boundary_size
240fd86
@jhabriel
Merge pull request #761 from pmgbergen/feat_domain_boundary_size
1533c7e 
Allow for tolerance specification in `domain_boundary_sides()`
@keileg
BLD: Update CODEOWNERS
eda6862
@jhabriel
MAINT: Refactor of domain boundary sides
40fdd7d
@jhabriel
DOC: Incorporate @IvarStefansson suggestion.
864d4af
@jhabriel
Merge pull request #766 from pmgbergen/refactor_domain_boundary_sides
89ba86c 
MAINT: Refactor of domain boundary sides
@vlipovac @keileg
Maint ad docs (#763)
958a55d 
* DOCS: Update docs of some AD objects.

* MAINT: Typing and docstrings of some AD objects.

* Update src/porepy/numerics/ad/operator_functions.py

Co-authored-by: Eirik Keilegavlen <Eirik.Keilegavlen@uib.no>

* STY: Return type in ADMethod.ad_wrapper fixed (mypy).

* STY: ambigous return type of Operator.evaluate

Co-authored-by: Eirik Keilegavlen <Eirik.Keilegavlen@uib.no>
@keileg
BLD: Update code owners
f9444ce
@vlipovac
ENH: Extended documentation cases in example docs.
187d5f9
@vlipovac
MIN: Changes to example docs.
6fef6d2
@vlipovac
UPDATE: docs theme and configurations
a78813f
@vlipovac vlipovac marked this pull request as ready for review November 24, 2022 16:34
@vlipovac vlipovac self-assigned this Nov 24, 2022
@vlipovac vlipovac added the documentation Issue/PR related to documentation. label Nov 24, 2022
vlipovac and others added 27 commits November 25, 2022 13:20
@vlipovac
MAIN: Renamind entry page to index
bfeeaa9
@vlipovac
FIX: Index.html access to html build.
817adf1
@vlipovac
DOC: Updating documentation how-to.
80d2159
@keileg @vlipovac
DOC: Comments and changes to documentation template
37f8287
@vlipovac
DOC: Min changes to style.
d538d3e
@vlipovac
DOC: Including remarks by EK into style guide.
55e0fe0
@vlipovac
STY: Style update in example docs.
dbddc79
@vlipovac
FIX: docs in example documentation.
0a27b87
@vlipovac
MAINT: Adding pre-compiled example docs.
2ff0778
@vlipovac
Rebase on develop.
0b79738
@vlipovac
DOC: Specify module in AD docs for source tags.
8e3c5e9
@vlipovac
DOC: Restructuring docsrc.
81cd4f0
@vlipovac
Rebase docs_update on develop
94e5a55
@vlipovac
DOC: Fixing docs for some AD classes.
243110e
@vlipovac
DOC: Fixing html
ad25556
@keileg @vlipovac
Delete .nojekyll
f0e9106
@keileg @vlipovac
Create .nojekyll
43217b5
@vlipovac
DOC: nojekyll
0e72bd1
@vlipovac
Synchronize docs develop (#768)
95b1afb 
MAINT: synchronize develop and docs
@vlipovac
ENH: Extended documentation cases in example docs.
5e58bde
@vlipovac
MIN: Changes to example docs.
210fffe
@vlipovac
UPDATE: docs theme and configurations
a9dd743
@vlipovac
UPDATE: package requirements include sphinx and sphinx-rtd-theme now.
14d7037
@vlipovac
MAINT: Update Sphinx requirements for developers.
920b97b
@vlipovac
REVERT: Changes to requirements (now in separate issue 774)
f54bf3f
@vlipovac
Merge branch 'docs_update' of github.com:pmgbergen/porepy into docs_u…
54152a9 
…pdate
@vlipovac
MIN: synchronize with develop
79523bc
keileg
keileg approved these changes Nov 25, 2022
View reviewed changes
Copy link
Contributor

@keileg keileg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only changes to docs and files that are rebased from develop. Good.

@vlipovac vlipovac merged commit 4ed3c82 into docs Nov 25, 2022
@vlipovac vlipovac deleted the docs_update branch November 25, 2022 13:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@keileg keileg keileg approved these changes

@IvarStefansson IvarStefansson Awaiting requested review from IvarStefansson IvarStefansson is a code owner

Assignees

@vlipovac vlipovac

Labels

documentation Issue/PR related to documentation.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@vlipovac @keileg @jhabriel