Skip to content

Commit

Permalink
add black and pymdownx.magiclink to dependencies,
Browse files Browse the repository at this point in the history
increase line length in docstring generation, update
api_reference
  • Loading branch information
rggdmonk committed Nov 10, 2023
1 parent 9c99d7e commit 057edba
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 4 deletions.
1 change: 1 addition & 0 deletions .github/workflows/mkdocs_material.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,5 @@ jobs:
mkdocstrings \
mkdocstrings-python \
pymdown-extensions \
black \
- run: mkdocs gh-deploy --force
4 changes: 2 additions & 2 deletions docs/gen_ref_pages.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

module_path = path.relative_to("hadal").with_suffix("")
doc_path = path.relative_to("hadal").with_suffix(".md")
full_doc_path = Path("reference", doc_path)
full_doc_path = Path("api_reference", doc_path)

parts = tuple(module_path.parts)

Expand All @@ -34,5 +34,5 @@

mkdocs_gen_files.set_edit_path(full_doc_path, path)

with mkdocs_gen_files.open("reference/SUMMARY.md", "w") as nav_file:
with mkdocs_gen_files.open("api_reference/SUMMARY.md", "w") as nav_file:
nav_file.writelines(nav.build_literate_nav())
5 changes: 3 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ markdown_extensions:
- markdown.extensions.tables:
- markdown.extensions.toc:
permalink: true
- pymdownx.magiclink
- attr_list
- md_in_html
- pymdownx.superfences
Expand Down Expand Up @@ -97,7 +98,7 @@ plugins:
docstring_section_style: list
annotations_path: source
separate_signature: true
line_length: 60
line_length: 80
show_signature: true
show_signature_annotations: true
members_order: source
Expand All @@ -111,7 +112,7 @@ nav:
- parallel_text.md
- parallel_sentence_mining/margin_based.md
- API reference:
- hadal: reference/
- hadal: api_reference/

extra_css:
- stylesheets/extra.css

0 comments on commit 057edba

Please sign in to comment.