Skip to content

Use mkapi for nicer docs #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
moble wants to merge 14 commits into
base: main
Choose a base branch
from
Draft

Use mkapi for nicer docs #15

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
a705dac
Try out mktheapidocs -> mkapi
moble Sep 8, 2020
62d9558
More complete docstrings
moble Sep 8, 2020
450325b
Fix typos
moble Sep 8, 2020
16cfd41
Tell mkdocs and readthedocs about mkapi
moble Sep 8, 2020
fe444b4
Remove stray whitespace
moble Oct 21, 2020
55ea0d0
Correct name of quaternionic_array_factory after rebase
moble Oct 21, 2020
a679938
Adjust array.__qualname__ to be less ugly
moble Oct 21, 2020
25be04d
Tweak some docstrings
moble Oct 22, 2020
72b8006
Remove comments from old branch
moble Oct 22, 2020
1c5640b
Update poetry
moble Oct 22, 2020
ece33f8
Tweak some docstrings
moble Oct 22, 2020
0836c00
Fix some accidental renamings
moble Oct 22, 2020
31058d8
Fix some accidental renamings
moble Oct 22, 2020
b669165
Minor docstring tweaks [skip ci]
moble Oct 23, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Tell mkdocs and readthedocs about mkapi
  • Loading branch information
@moble
moble committed Oct 21, 2020
commit 16cfd411fdc193227f498d5f81506c1f1e80d753
2 changes: 1 addition & 1 deletion .readthedocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,5 @@ python:
path: .
extra_requirements:
- mkdocs
- mktheapidocs
- mkapi
- pymdown-extensions
22 changes: 11 additions & 11 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
site_name: quaternionic

# repo_url: https://github.com/moble/quaternionic
repo_url: https://github.com/moble/quaternionic

plugins:
- search
Expand All @@ -13,16 +13,16 @@ plugins:

nav:
- index.md
- API2: mkapi/api/quaternionic
- API: mkapi/api/quaternionic

# theme:
# name: 'readthedocs'
theme:
name: 'readthedocs'

# extra_javascript:
# - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-svg.js
extra_javascript:
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-svg.js

# markdown_extensions:
# - toc:
# permalink: "#"
# - pymdownx.arithmatex:
# generic: true
markdown_extensions:
- toc:
permalink: "#"
- pymdownx.arithmatex:
generic: true