Skip to content

Commit cf4c14a

Browse files
committed
Fix: addressing changes from @tupui
1 parent 210b1b6 commit cf4c14a

File tree

3 files changed

+8
-5
lines changed

3 files changed

+8
-5
lines changed

.github/workflows/build-book.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ jobs:
6767
with:
6868
directory: '_build/html'
6969
arguments: |
70-
--ignore-files "/.+\/_static\/.+/,/genindex.html/ "
71-
--ignore-status-codes "403, 503"
70+
--ignore-files "/.+\/_static\/.+/,/genindex.html/"
71+
--ignore-status-codes "404, 403, 503"
7272
7373

documentation/contributing-license-coc.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,9 @@ technically proficient users how to:
3434
* Run the test suite
3535
* Build documentation locally
3636

37+
The development guide should also have guidelines for:
38+
* code standards including docstring style, code format and any specific code approaches that the package follows.
39+
3740
It's also helpful to specify the types of tests you request if a contributor submits a new feature or a change to an existing feature that will not be covered by your existing test suite.
3841

3942
If you have time to document it, it's also helpful to document your maintainer workflow and release processes.

documentation/package-documentation-best-practices.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55
66
Your package:
77
* Should have a documentation website
8-
* All of its functions and classes (the API) documented
9-
* Your package should use numpy-style docstrings
10-
* Your documentation landing page should direct users to 4 core sections: get started, documentation content, about and community.
8+
* Should have all of its public (user-facing) functions and classes (the API) documented
9+
* Should use numpy-style docstrings
10+
* Documentation landing page should direct users to 4 core sections: get started, documentation content, about and community.
1111
* Documentation should include short quick-start tutorials
1212
```
1313

0 commit comments

Comments
 (0)