Initial commit

.gitignore

+site/
\ No newline at end of file

Dockerfile

+FROM python:3
+
+WORKDIR /usr/src/app
+
+RUN pip install mkdocs
+
+CMD [ "mkdocs", "serve" ]
\ No newline at end of file

Makefile

+UID := $(id -u)
+GID := $(id -g)
+NAME_APP=mkdocs
+
+list:
+	@echo ""
+	@echo "Useful targets:"
+	@echo ""
+	@echo "  install      > build mkdocs docker image"
+	@echo "  start        > run a dev server for $(NAME_APP) application (in memory)"
+	@echo "  stop         > stop the dev server for $(NAME_APP) application"
+	@echo "  restart      > restart the dev server for $(NAME_APP) (container)"
+	@echo "  status       > display $(NAME_APP) container status"
+	@echo "  build        > generate dist application (html, css, js)"
+	@echo "  logs         > display $(NAME_APP) container logs"
+	@echo "  shell        > shell into $(NAME_APP) container"
+	@echo ""
+
+install:
+	@docker build -t mkdocs-img . 
+
+start:
+	@docker run --init -it --rm \
+	--user $(UID):$(GID) \
+	--name $(NAME_APP) \
+	-p 8888:8888 \
+	-v $(CURDIR):/project  \
+	-w /project -d mkdocs-img mkdocs serve
+
+stop:
+	@docker stop $(NAME_APP)
+
+restart: stop start
+
+status:
+	@docker ps -f name=$(NAME_APP)
+
+build:
+	@docker run --init -it --rm \
+	--user $(UID):$(GID) \
+	-v $(CURDIR):/project  \
+	-w /project mkdocs-img mkdocs build --clean
+
+logs:
+	@docker logs -f -t $(NAME_APP)
+
+shell:
+	@docker exec -ti $(NAME_APP) bash

README.md

+# ANIS-DOC
+
+## Introduction
+
+Welcome to the ANIS user documentation repository. This manual is written using the mkdocs tool (https://www.mkdocs.org/).
+
+## Installation
+
+You will need the local image containing the mkdocs tool to use this repository.
+
+- To build the image : `make install`
+
+## Running dev-server
+
+MkDocs comes with a built-in dev-server that lets you preview your documentation as you work on it.
+
+- To run the dev-server : `make start`
+
+## Building documentation website
+
+The website is generated into a folder named `site`
+
+ - To build the documentation website : `make build`
+
+
+## Authors
+
+* `François Agneray` : Laboratoire d'Astrophysique de Marseille (CNRS)
\ No newline at end of file

docs/about.md

+# About AstroNomical Information System
+
+Anis has been developed by `Laboratoire d'Astrophysique de Marseille` to meet the needs of 
+the various scientific missions in which it is engaged.
+
+## Licence
+
+AstroNomical Information System is governed by the CeCILL license (Version 2.1 dated 2013-06-21) 
+under French law and abiding by the rules of distribution of free software.
+
+You can use, modify and/ or redistribute the software under the terms of the CeCILL
+license as circulated by CEA, CNRS and INRIA at the following URL
+[https://cecill.info](https://cecill.info) and / or below.
+
+## Authors
+
+Here is the list of people involved in the development:
+
+* `François Agneray` : Laboratoire d'Astrophysique de Marseille (CNRS)
+* `Chrystel Moreau` : Laboratoire d'Astrophysique de Marseille (CNRS)
+* `Tifenn Guillas` : Laboratoire d'Astrophysique de Marseille (CNRS)

docs/admin.md

+# Admin
\ No newline at end of file

docs/client.md

+# Client
\ No newline at end of file

docs/index.md

+# Welcome to the Anis Documentation
+
+## Introduction
+
+Welcome to the AstroNomical Information System user's manual.  
+Here you can find all the information you need to retrieve, install and develop with the latest version of Anis.
+
+Anis is composed of three sub-projects:  
+
+ - `anis-server`: It is a web api that allows users to search into business databases.
+ - `anis-client`: It is a web client that allows users to carry out searches and format the results.
+ - `anis-admin`: It is a web client, reserved for administrators only, and which allows to set up the anis instance.
+
+You can find in the left menu the links to the complete documentation for each parts.
+
+## Gitlab repository
+
+You can find the complete source code into the anis public repository : 
+
+ - [https://gitlab.lam.fr/anis](https://gitlab.lam.fr/anis)
+
+## Getting started
+

docs/server.md

+# Server
\ No newline at end of file

mkdocs.yml

+site_name: ANIS Documentation
+dev_addr: 0.0.0.0:8888
+theme: readthedocs
+nav:
+    - Home: index.md
+    - Server: server.md
+    - Client: client.md
+    - Admin: admin.md
+    - About: about.md
\ No newline at end of file