{"id":17332977,"url":"https://github.com/raybellwaves/myfavdocs","last_synced_at":"2025-03-27T06:26:20.685Z","repository":{"id":233957206,"uuid":"788091340","full_name":"raybellwaves/myfavdocs","owner":"raybellwaves","description":"My opinionated favourite (yes that u is left in favourite intentially) docs ","archived":false,"fork":false,"pushed_at":"2024-05-04T17:37:05.000Z","size":13949,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-01T11:41:30.545Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://raybellwaves.github.io/myfavdocs/","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/raybellwaves.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-04-17T18:55:36.000Z","updated_at":"2024-05-04T17:36:37.000Z","dependencies_parsed_at":"2024-05-04T15:56:29.051Z","dependency_job_id":"eb75d89b-c807-4eef-9dfe-dbd23136dff0","html_url":"https://github.com/raybellwaves/myfavdocs","commit_stats":null,"previous_names":["raybellwaves/myfavdocs"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raybellwaves%2Fmyfavdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raybellwaves%2Fmyfavdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raybellwaves%2Fmyfavdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raybellwaves%2Fmyfavdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/raybellwaves","download_url":"https://codeload.github.com/raybellwaves/myfavdocs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245794245,"owners_count":20673149,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-15T14:59:21.408Z","updated_at":"2025-03-27T06:26:20.661Z","avatar_url":"https://github.com/raybellwaves.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# myfavdocs\nMy opinionated favourite (yes that u is left in favourite intentially) docs.\nHosted at https://raybellwaves.github.io/myfavdocs/.\n\nThe code to generate the files is `make_files.sh` and is designed to run on a Mac.\n\nThis came about when starting with https://www.sphinx-doc.org/en/master/tutorial/getting-started.html and https://www.sphinx-doc.org/en/master/development/tutorials/index.html and building upon them.\n\nWhat I like and why:\n - xarray (https://docs.xarray.dev/en/stable/) has my favorite docs but I may be biased. I made decisions here based in their configuration.\n - Using `sphinx.ext.napoleon` over `numpydoc` as it gives hyperlinks of types in the Parameters and Return. I also like the bullet points that it uses for Parameters.\n - Using `pydata_sphinx_theme` for the html theme.\n - In my case I left `autodoc_typehints` as the default. You can set it to `None` if you have types that get pretty long e.g. `Optional[dict[str | int, list[int | str], float]]...`","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fraybellwaves%2Fmyfavdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fraybellwaves%2Fmyfavdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fraybellwaves%2Fmyfavdocs/lists"}