https://github.com/srtab/alexandriadocs
AlexandriaDocs is a Django project that allows you to host, group, and index all your static documentation.
https://github.com/srtab/alexandriadocs
django django-project documentation python python3
Last synced: about 1 year ago
JSON representation
AlexandriaDocs is a Django project that allows you to host, group, and index all your static documentation.
- Host: GitHub
- URL: https://github.com/srtab/alexandriadocs
- Owner: srtab
- License: apache-2.0
- Created: 2017-03-24T20:07:13.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2018-08-04T08:15:25.000Z (almost 8 years ago)
- Last Synced: 2025-02-09T21:13:35.241Z (over 1 year ago)
- Topics: django, django-project, documentation, python, python3
- Language: Python
- Homepage:
- Size: 9.47 MB
- Stars: 2
- Watchers: 4
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# AlexandriaDocs
[](https://travis-ci.org/srtab/alexandriadocs)
[](https://www.codacy.com/app/srtabs/alexandriadocs?utm_source=github.com&utm_medium=referral&utm_content=srtab/alexandriadocs&utm_campaign=Badge_Grade)
[](https://coveralls.io/github/srtab/alexandriadocs?branch=master)
[](https://bettercodehub.com/)
Allows 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.
AlexandriaDocs is built with Django 2.0 and supports Python 3.4, 3.5 and 3.6.
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
### Prerequisites
* [Docker](https://docs.docker.com/engine/installation/);
* [Docker Compose](https://docs.docker.com/compose/install/).
### Installing
Start by cloning the project to your local machine:
```shell
$ git clone https://github.com/srtab/alexandriadocs
```
Enter on the cloned folder and start `docker-compose` with build flag:
```shell
$ cd alexandriadocs
$ docker-compose up --build
```
After the build finished, go to `http://127.0.0.1:8000`.
## Running the tests
You need to enter in the `app` container to execute the tests:
```shell
$ docker-compose exec app bash
```
### Unit tests
We 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.
Finally, to run the unit tests in our local machines:
```shell
$ tox -e py34
```
### And coding style tests
For code styling tests we use `flake8`:
```
$ tox -e flake8
```
## Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/srtab/alexandriadocs/tags).
## Authors
* **Sandro Rodrigues** - *Initial work* - [srtab](https://github.com/srtab)
See also the list of [contributors](https://github.com/srtab/alexandriadocs/contributors) who participated in this project.
## License
This project is licensed under the Apache-2.0 - see the [LICENSE.md](LICENSE.md) file for details.