{"id":20618254,"url":"https://github.com/tddschn/easygraph-doc-source","last_synced_at":"2025-03-06T19:43:28.893Z","repository":{"id":110176679,"uuid":"587618875","full_name":"tddschn/easygraph-doc-source","owner":"tddschn","description":"Scripts and guides for generating documentation for EasyGraph","archived":false,"fork":false,"pushed_at":"2023-05-30T10:16:58.000Z","size":39092,"stargazers_count":2,"open_issues_count":0,"forks_count":4,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-17T04:47:53.191Z","etag":null,"topics":["easygraph","furo","python-easygraph","sphinx"],"latest_commit_sha":null,"homepage":"https://github.com/tddschn/easygraph-doc-source","language":"HTML","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/tddschn.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":"2023-01-11T07:13:43.000Z","updated_at":"2023-05-04T11:54:04.000Z","dependencies_parsed_at":null,"dependency_job_id":"29ec3025-ea85-4d31-ad64-aa32b4488ac6","html_url":"https://github.com/tddschn/easygraph-doc-source","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tddschn%2Feasygraph-doc-source","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tddschn%2Feasygraph-doc-source/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tddschn%2Feasygraph-doc-source/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tddschn%2Feasygraph-doc-source/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tddschn","download_url":"https://codeload.github.com/tddschn/easygraph-doc-source/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242277652,"owners_count":20101536,"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":["easygraph","furo","python-easygraph","sphinx"],"created_at":"2024-11-16T12:07:43.905Z","updated_at":"2025-03-06T19:43:28.885Z","avatar_url":"https://github.com/tddschn.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Scripts and guides for generating documentation for EasyGraph\n\n\u003c!-- Author: [Teddy Xinyuan Chen](https://github.com/tddschn) --\u003e\n\nRepository: [easygraph-doc-source](https://github.com/easy-graph/easygraph-doc-source)\n\n- [Scripts and guides for generating documentation for EasyGraph](#scripts-and-guides-for-generating-documentation-for-easygraph)\n  - [Prerequisites](#prerequisites)\n  - [Update `rst` files](#update-rst-files)\n    - [Edit manually created `rst` files](#edit-manually-created-rst-files)\n    - [Generate `rst` files from docstrings as references](#generate-rst-files-from-docstrings-as-references)\n  - [Build HTML from `rst` files](#build-html-from-rst-files)\n  - [Deploy to easy-graph.github.io](#deploy-to-easy-graphgithubio)\n  - [Troubleshooting](#troubleshooting)\n    - [Reference built but not correctly displayed on the website](#reference-built-but-not-correctly-displayed-on-the-website)\n\n## Prerequisites\n\nClone these repositories and put them inside the same directory:\n\n```bash\nREPOS=('Easy-Graph' 'easy-graph.github.io' 'easygraph-doc-source')\nfor i in \"${REPOS[@]}\"; do\n    echo \"Cloning: $i\"\n    git clone \"https://github.com/easy-graph/$i\"\ndone\n```\n\n## Update `rst` files\n\n### Edit manually created `rst` files\n\nGo to `easygraph-doc-source/docs_using_sphinx`, and hand-edit / remove / add any `rst` files outside of `reference`.\n\n### Generate `rst` files from docstrings as references\n\n\n```bash\ncd easygraph-doc-source/docs_using_sphinx\nmake gen-rst\n# generated rst files in reference dir\n```\n\n## Build HTML from `rst` files\n\n\u003c!-- 1. Update the `.rst` file in `docs_using_sphinx`\n2. Run terminal, changing work directory to `docs_using_sphinx`\n3. run `python3 -m venv .env` for the virtual environment\n4. run `source .env/bin/activate` to activate\n5. run `pip install -r requirements.txt` to install dependencies --\u003e\n- Install dependencies in `requirements.txt`.\n- Run ` make html`. The updated pages locate in `./_build/html`.\n\n## Deploy to easy-graph.github.io\n\n- Sync all the files under `./_build/html` to repository `easy-graph.github.io`:\n\n```bash\ncd easygraph-doc-source\nmake sync-doc-pub-repo\n```\n\n- Push the changes of these two repository to their remotes\n\n## Troubleshooting\n\n### Reference built but not correctly displayed on the website\n- Check the `toctree` of `reference.rst`, you may need to manually update the section to reflect the built references.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftddschn%2Feasygraph-doc-source","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftddschn%2Feasygraph-doc-source","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftddschn%2Feasygraph-doc-source/lists"}