{"id":13648139,"url":"https://github.com/ppwwyyxx/dash-docset-jax","last_synced_at":"2025-08-19T03:12:42.905Z","repository":{"id":61215156,"uuid":"497887147","full_name":"ppwwyyxx/dash-docset-jax","owner":"ppwwyyxx","description":"Create nice dash/zeal docset for JAX+Flax","archived":false,"fork":false,"pushed_at":"2023-11-02T00:42:32.000Z","size":477,"stargazers_count":7,"open_issues_count":0,"forks_count":2,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-11T18:56:10.977Z","etag":null,"topics":["dash","flax","jax","zeal"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ppwwyyxx.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2022-05-30T10:06:24.000Z","updated_at":"2023-11-23T10:54:51.000Z","dependencies_parsed_at":"2024-01-14T11:08:00.055Z","dependency_job_id":null,"html_url":"https://github.com/ppwwyyxx/dash-docset-jax","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/ppwwyyxx/dash-docset-jax","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ppwwyyxx%2Fdash-docset-jax","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ppwwyyxx%2Fdash-docset-jax/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ppwwyyxx%2Fdash-docset-jax/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ppwwyyxx%2Fdash-docset-jax/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ppwwyyxx","download_url":"https://codeload.github.com/ppwwyyxx/dash-docset-jax/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ppwwyyxx%2Fdash-docset-jax/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271093239,"owners_count":24697969,"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","status":"online","status_checked_at":"2025-08-19T02:00:09.176Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["dash","flax","jax","zeal"],"created_at":"2024-08-02T01:03:59.986Z","updated_at":"2025-08-19T03:12:42.881Z","avatar_url":"https://github.com/ppwwyyxx.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"## JAX+Flax offline documentation in [dash](https://kapeli.com/dash)/[zeal](https://github.com/zealdocs/zeal) docset browser\n\n![screenshot](/screenshot.jpg)\n\nTo use, you can add this feed in Dash/Zeal directly:\n```\nhttps://raw.githubusercontent.com/ppwwyyxx/dash-docset-jax/master/Jax.xml\n```\nOr download the latest release [here](https://github.com/ppwwyyxx/dash-docset-jax/releases).\n\n\n## Steps to generate the docset\n\n1. Install JAX and Flax\n1. `pip install tqdm python-magic selectolax doc2dash beautifulsoup4 lxml`\n1. Build their documentation together:\n   ```\n   git clone https://github.com/google/jax /tmp/jax\n   git clone https://github.com/google/flax /tmp/flax\n\n   cd /tmp/flax/docs/\n   # Install necessary doc dependencies from requirements.txt, then:\n   sphinx-build -b html -D nb_execution_mode=off ./ ./build/html -j auto\n\n   cd /tmp/jax/docs\n   cp -rv /tmp/flax/docs/api_reference/flax.* ./\n   # Install necessary doc dependencies from requirements.txt, then:\n   sphinx-build -b html -D nb_execution_mode=off ./ ./build/html -j auto\n   ```\n1. `cd` to this project, then run the following to beautify the docs:\n   ```\n   export HTML_DIR=/tmp/jax/docs/build/html\n   # Beautify the docs for more friendly display:\n   ./transform.py $HTML_DIR\n   # Use monospace font for code:\n   sed -i 's/var(--pst-font-family-monospace)/monospace/g' $HTML_DIR/**/*.css\n   doc2dash -f -d ./ -u https://jax.readthedocs.io/ --name jax -i icon.png $HTML_DIR\n   ```\n   This will generate `jax.docset` that can be installed into Zeal/Dash.\n\n\n## Others\n\n* Latex renders correctly:\n\n![math](/math.jpg)\n\n* Syntax highlight works (check `flax.linen.map_variables`)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fppwwyyxx%2Fdash-docset-jax","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fppwwyyxx%2Fdash-docset-jax","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fppwwyyxx%2Fdash-docset-jax/lists"}