WIP: Add Persian and English mkdocs #30
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
That is not our TOP priority, but we'll work on this branch. |
ManiMozaffar
changed the title
14 tasks
ManiMozaffar
requested changes
Aug 25, 2023
Comment on lines
+1
to
+20
| maintainers: | ||
| - login: tiangolo | ||
| answers: 1844 | ||
| prs: 430 | ||
| avatarUrl: https://avatars.githubusercontent.com/u/1326112?u=740f11212a731f56798f558ceddb0bd07642afa7&v=4 | ||
| url: https://github.com/tiangolo | ||
| experts: | ||
| - login: Kludex | ||
| count: 434 | ||
| avatarUrl: https://avatars.githubusercontent.com/u/7353520?u=62adc405ef418f4b6c8caa93d3eb8ab107bc4927&v=4 | ||
| url: https://github.com/Kludex | ||
| - login: dmontagu | ||
| count: 237 | ||
| avatarUrl: https://avatars.githubusercontent.com/u/35119617?u=540f30c937a6450812628b9592a1dfe91bbe148e&v=4 | ||
| url: https://github.com/dmontagu | ||
| - login: Mause | ||
| count: 220 | ||
| avatarUrl: https://avatars.githubusercontent.com/u/1405026?v=4 | ||
| url: https://github.com/Mause | ||
| - login: ycd |
There was a problem hiding this comment.
can you get rid of these people? they're FastAPI's people not us haha
Maybe you can add us as maintainers :)
Comment on lines
+1
to
+4
| sponsors: | ||
| - - login: cryptapi | ||
| avatarUrl: https://avatars.githubusercontent.com/u/44925437?u=61369138589bc7fee6c417f3fbd50fbd38286cc4&v=4 | ||
| url: https://github.com/cryptapi |
Comment on lines
+1
to
+18
| logins: | ||
| - jina-ai | ||
| - deta | ||
| - investsuite | ||
| - mikeckennedy | ||
| - deepset-ai | ||
| - cryptapi | ||
| - xoflare | ||
| - DropbaseHQ | ||
| - VincentParedes | ||
| - BLUE-DEVIL1134 | ||
| - ObliviousAI | ||
| - Doist | ||
| - nihpo | ||
| - svix | ||
| - armand-sauzay | ||
| - databento-bot | ||
| - nanram22 |
Comment on lines
+34
to
+42
| * **Fast**: Very high performance, on par with **NodeJS** and **Go** (thanks to Starlette and Pydantic). [One of the fastest Python frameworks available](#performance). | ||
| * **Fast to code**: Increase the speed to develop features by about 200% to 300%. * | ||
| * **Fewer bugs**: Reduce about 40% of human (developer) induced errors. * | ||
| * **Intuitive**: Great editor support. <abbr title="also known as auto-complete, autocompletion, IntelliSense">Completion</abbr> everywhere. Less time debugging. | ||
| * **Easy**: Designed to be easy to use and learn. Less time reading docs. | ||
| * **Short**: Minimize code duplication. Multiple features from each parameter declaration. Fewer bugs. | ||
| * **Robust**: Get production-ready code. With automatic interactive documentation. | ||
| * **Standards-based**: Based on (and fully compatible with) the open standards for APIs: <a href="https://github.com/OAI/OpenAPI-Specification" class="external-link" target="_blank">OpenAPI</a> (previously known as Swagger) and <a href="https://json-schema.org/" class="external-link" target="_blank">JSON Schema</a>. | ||
|
|
Comment on lines
+1
to
+132
| dir_path = Path(config.docs_dir) | ||
| lang = dir_path.parent.name | ||
| if lang in available_langs: | ||
| config.theme["language"] = lang | ||
| if not (config.site_url or "").endswith(f"{lang}/") and not lang == "en": | ||
| config.site_url = f"{config.site_url}{lang}/" | ||
| return config | ||
|
|
||
|
|
||
| def resolve_file(*, item: str, files: Files, config: MkDocsConfig) -> None: | ||
| item_path = Path(config.docs_dir) / item | ||
| if not item_path.is_file(): | ||
| en_src_dir = (Path(config.docs_dir) / "../../en/docs").resolve() | ||
| potential_path = en_src_dir / item | ||
| if potential_path.is_file(): | ||
| files.append( | ||
| EnFile( | ||
| path=item, | ||
| src_dir=str(en_src_dir), | ||
| dest_dir=config.site_dir, | ||
| use_directory_urls=config.use_directory_urls, | ||
| ) | ||
| ) | ||
|
|
||
|
|
||
| def resolve_files(*, items: List[Any], files: Files, config: MkDocsConfig) -> None: | ||
| for item in items: | ||
| if isinstance(item, str): | ||
| resolve_file(item=item, files=files, config=config) | ||
| elif isinstance(item, dict): | ||
| assert len(item) == 1 | ||
| values = list(item.values()) | ||
| if not values: | ||
| continue | ||
| if isinstance(values[0], str): | ||
| resolve_file(item=values[0], files=files, config=config) | ||
| elif isinstance(values[0], list): | ||
| resolve_files(items=values[0], files=files, config=config) | ||
| else: | ||
| raise ValueError(f"Unexpected value: {values}") | ||
|
|
||
|
|
||
| def on_files(files: Files, *, config: MkDocsConfig) -> Files: | ||
| resolve_files(items=config.nav or [], files=files, config=config) | ||
| if "logo" in config.theme: | ||
| resolve_file(item=config.theme["logo"], files=files, config=config) | ||
| if "favicon" in config.theme: | ||
| resolve_file(item=config.theme["favicon"], files=files, config=config) | ||
| resolve_files(items=config.extra_css, files=files, config=config) | ||
| resolve_files(items=config.extra_javascript, files=files, config=config) | ||
| return files | ||
|
|
||
|
|
||
| def generate_renamed_section_items( | ||
| items: List[Union[Page, Section, Link]], *, config: MkDocsConfig | ||
| ) -> List[Union[Page, Section, Link]]: | ||
| new_items: List[Union[Page, Section, Link]] = [] | ||
| for item in items: | ||
| if isinstance(item, Section): | ||
| new_title = item.title | ||
| new_children = generate_renamed_section_items(item.children, config=config) | ||
| first_child = new_children[0] | ||
| if isinstance(first_child, Page): | ||
| if first_child.file.src_path.endswith("index.md"): | ||
| # Read the source so that the title is parsed and available | ||
| first_child.read_source(config=config) | ||
| new_title = first_child.title or new_title | ||
| # Creating a new section makes it render it collapsed by default | ||
| # no idea why, so, let's just modify the existing one | ||
| # new_section = Section(title=new_title, children=new_children) | ||
| item.title = new_title | ||
| item.children = new_children | ||
| new_items.append(item) | ||
| else: | ||
| new_items.append(item) | ||
| return new_items | ||
|
|
||
|
|
||
| def on_nav( | ||
| nav: Navigation, *, config: MkDocsConfig, files: Files, **kwargs: Any | ||
| ) -> Navigation: | ||
| new_items = generate_renamed_section_items(nav.items, config=config) | ||
| return Navigation(items=new_items, pages=nav.pages) | ||
|
|
||
|
|
||
| def on_pre_page(page: Page, *, config: MkDocsConfig, files: Files) -> Page: | ||
| return page | ||
|
|
||
|
|
||
| def on_page_markdown( | ||
| markdown: str, *, page: Page, config: MkDocsConfig, files: Files | ||
| ) -> str: | ||
| if isinstance(page.file, EnFile): | ||
| missing_translation_content = get_missing_translation_content(config.docs_dir) | ||
| header = "" | ||
| body = markdown | ||
| if markdown.startswith("#"): | ||
| header, _, body = markdown.partition("\n\n") | ||
| return f"{header}\n\n{missing_translation_content}\n\n{body}" | ||
| return markdown |
There was a problem hiding this comment.
Again doc missing
- Add doc string to each function, explaining what it does
- Make sure it's not fastapi related
Comment on lines
+10
to
+14
| python3.6 -m pip install --user flit | ||
| # Install with Flit | ||
| python3.6 -m flit install --user --extras doc | ||
| # Finally, run mkdocs | ||
| python3.6 -m mkdocs build |
There was a problem hiding this comment.
why should we use python 3.6?
|
|
||
| set -e | ||
|
|
||
| flit publish |
There was a problem hiding this comment.
i don't think this is how we manage our publish
Comment on lines
+6
to
+9
| bash scripts/test.sh ${@} | ||
| coverage combine | ||
| coverage report --show-missing | ||
| coverage html |
There was a problem hiding this comment.
contact with amir bahador regarding this.
Comment on lines
+1
to
+7
| #!/usr/bin/env bash | ||
|
|
||
| set -e | ||
| set -x | ||
|
|
||
| export PYTHONPATH=./docs_src | ||
| coverage run -m pytest tests ${@} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I have added Persian and English mkdocs to the project, but they need to be cleaner and better from now on.