{"id":16329505,"url":"https://github.com/srtab/alexandriadocs","last_synced_at":"2025-04-04T11:02:46.465Z","repository":{"id":197905462,"uuid":"86106526","full_name":"srtab/alexandriadocs","owner":"srtab","description":"AlexandriaDocs is a Django project that allows you to host, group, and index all your static documentation.","archived":false,"fork":false,"pushed_at":"2018-08-04T08:15:25.000Z","size":9933,"stargazers_count":2,"open_issues_count":3,"forks_count":0,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-02-09T21:13:35.241Z","etag":null,"topics":["django","django-project","documentation","python","python3"],"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/srtab.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2017-03-24T20:07:13.000Z","updated_at":"2019-01-24T22:15:46.000Z","dependencies_parsed_at":"2023-10-03T11:20:24.798Z","dependency_job_id":null,"html_url":"https://github.com/srtab/alexandriadocs","commit_stats":null,"previous_names":["srtab/alexandriadocs"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/srtab%2Falexandriadocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/srtab%2Falexandriadocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/srtab%2Falexandriadocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/srtab%2Falexandriadocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/srtab","download_url":"https://codeload.github.com/srtab/alexandriadocs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247166161,"owners_count":20894653,"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":["django","django-project","documentation","python","python3"],"created_at":"2024-10-10T23:15:52.935Z","updated_at":"2025-04-04T11:02:46.435Z","avatar_url":"https://github.com/srtab.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# AlexandriaDocs\n\n[![Build Status](https://travis-ci.org/srtab/alexandriadocs.svg?branch=master)](https://travis-ci.org/srtab/alexandriadocs)\n[![Codacy Badge](https://api.codacy.com/project/badge/Grade/f3ff11fbcbdd4ef1ade40d8033e7642f)](https://www.codacy.com/app/srtabs/alexandriadocs?utm_source=github.com\u0026amp;utm_medium=referral\u0026amp;utm_content=srtab/alexandriadocs\u0026amp;utm_campaign=Badge_Grade)\n[![Coverage Status](https://coveralls.io/repos/github/srtab/alexandriadocs/badge.svg?branch=master)](https://coveralls.io/github/srtab/alexandriadocs?branch=master)\n[![BCH compliance](https://bettercodehub.com/edge/badge/srtab/alexandriadocs?branch=master)](https://bettercodehub.com/)\n\nAllows you to host, group, and easily search all you documentation. It supports static site generators like Sphinx, MkDocs, Jekyll, Hugo, ... and many [others](https://www.staticgen.com/). You can use your favorite continuous integration tool to generate and send new versions through the available API JSON, or you can just do it manually.\n\nAlexandriaDocs is built with Django 2.0 and supports Python 3.4, 3.5 and 3.6.\n\n## Getting Started\nThese instructions will get you a copy of the project up and running on your local machine for development and testing purposes.\n\n### Prerequisites\n* [Docker](https://docs.docker.com/engine/installation/);\n* [Docker Compose](https://docs.docker.com/compose/install/).\n\n### Installing\nStart by cloning the project to your local machine:\n```shell\n$ git clone https://github.com/srtab/alexandriadocs\n```\n\nEnter on the cloned folder and start `docker-compose` with build flag:\n```shell\n$ cd alexandriadocs\n$ docker-compose up --build\n```\n\nAfter the build finished, go to `http://127.0.0.1:8000`.\n\n## Running the tests\nYou need to enter in the `app` container to execute the tests:\n```shell\n$ docker-compose exec app bash\n```\n\n### Unit tests\nWe use `tox` to execute our tests and its configured to run in `python34`, `python35` and `python36`. For now, `app` image only have `python34` installed. The others versions are used to run on TravisCI.\n\nFinally, to run the unit tests in our local machines:\n```shell\n$ tox -e py34\n```\n\n### And coding style tests\nFor code styling tests we use `flake8`:\n```\n$ tox -e flake8\n```\n\n## Versioning\nWe use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/srtab/alexandriadocs/tags).\n\n## Authors\n* **Sandro Rodrigues** - *Initial work* - [srtab](https://github.com/srtab)\n\nSee also the list of [contributors](https://github.com/srtab/alexandriadocs/contributors) who participated in this project.\n\n## License\nThis project is licensed under the Apache-2.0 - see the [LICENSE.md](LICENSE.md) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsrtab%2Falexandriadocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsrtab%2Falexandriadocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsrtab%2Falexandriadocs/lists"}