{"id":22741821,"url":"https://github.com/http-apis/documentation-hydrus","last_synced_at":"2025-04-23T22:42:45.037Z","repository":{"id":78271889,"uuid":"121544178","full_name":"HTTP-APIs/documentation-hydrus","owner":"HTTP-APIs","description":"Sphinx documentation, for deploying in readthedocs.org","archived":false,"fork":false,"pushed_at":"2020-05-23T17:09:53.000Z","size":332,"stargazers_count":2,"open_issues_count":5,"forks_count":3,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-04-20T16:23:12.646Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/HTTP-APIs.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,"dei":null}},"created_at":"2018-02-14T18:12:24.000Z","updated_at":"2020-05-23T17:09:56.000Z","dependencies_parsed_at":"2023-03-12T03:59:35.460Z","dependency_job_id":null,"html_url":"https://github.com/HTTP-APIs/documentation-hydrus","commit_stats":{"total_commits":6,"total_committers":4,"mean_commits":1.5,"dds":0.6666666666666667,"last_synced_commit":"b8c824b386ff40f3de66a9155a26ad7a9bd66b9f"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HTTP-APIs%2Fdocumentation-hydrus","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HTTP-APIs%2Fdocumentation-hydrus/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HTTP-APIs%2Fdocumentation-hydrus/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HTTP-APIs%2Fdocumentation-hydrus/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/HTTP-APIs","download_url":"https://codeload.github.com/HTTP-APIs/documentation-hydrus/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250528681,"owners_count":21445511,"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-12-11T00:18:04.154Z","updated_at":"2025-04-23T22:42:45.013Z","avatar_url":"https://github.com/HTTP-APIs.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# documentation-hydrus\nThis reposity contains documentation of [hydrus](https://github.com/HTTP-APIs/hydrus) built using [Sphinx](http://www.sphinx-doc.org/en/master/#)\n\nYou can check the current documentation [here](http://hydrus.readthedocs.io/en/latest/)\n\n### Steps to build doc\n\n* Clone this repository.\n```\n$ git clone https://github.com/HTTP-APIs/documentation-hydrus.git\n```\n\n* Clone the [hydrus](https://github.com/HTTP-APIs/hydrus) repository.\n```\n$ git clone https://github.com/HTTP-APIs/hydrus.git\n```\n\n* It is recommended to use [virtualenv](https://virtualenv.pypa.io/en/stable/installation/) and [virtualenvwrapper](https://virtualenvwrapper.readthedocs.io/en/latest/install.html) to maintain a clean environment.\n```\n$ source `which virtualenvwrapper.sh`\n$ mkvirtualenv -p python3 hydrus\n(hydrus) $ deactivate         # To deactivate the virtual environment\n$ workon hydrus               # To activate virtual environment\n```\n\n* Install requirements\n```\n(hydrus)$ cd documentation-hydrus \n(hydrus)$ pip install -r requirements.txt\n```\n\n* Install hydrus\n```\n(hydrus)$ cd hydrus           # Go to your hydrus folder\n(hydrus)$ pip install -e .    # To install hydrus\n```\n\n* Copy the doc folder from documentation-hydrus folder to hydrus folder (Important step).\n\n* Everything is done now you can build the doc's .\n```\n(hydrus)$ cd hydrus/doc                 # The doc folder which was copied from documentation-hydrus to hydrus\n(hydrus)$ sphinx-build -b html path/to/hydrus/doc/rst path/to/hydrus/doc/_build/html\n```\nWhere \"path/to/hydrus/doc/rst\" and \"path/to/hydrus/doc/_build/html\" are your local folder path.\n\n* To make a clean build\n```\n(hydrus)$ make clean\n(hydrus)$ sphinx-build -b html path/to/hydrus/doc/rst path/to/hydrus/doc/_build/html\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhttp-apis%2Fdocumentation-hydrus","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhttp-apis%2Fdocumentation-hydrus","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhttp-apis%2Fdocumentation-hydrus/lists"}