Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Initial set-up for ReadtheDocs documentation for Perseo Front End. #304

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 5 additions & 0 deletions documentation/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Perseo-FE (EPL server)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"(EPL Server)" should be removed

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed 6c4b6af


[![FIWARE Processing](https://nexus.lab.fiware.org/static/badges/chapters/processing.svg)](https://www.fiware.org/developers/catalogue/)
[![](https://nexus.lab.fiware.org/repository/raw/public/badges/stackoverflow/fiware.svg)](https://stackoverflow.com/questions/tagged/fiware)

27 changes: 27 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
site_name: Perseo Front End
site_url: https://fiware-perseo-fe.readthedocs.org
repo_url: https://github.com/telefonicaid/perseo-fe.git
site_description: Perseo-Front End (EPL server)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"(EPL Server)" should be removed

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed 5d12de7

docs_dir: documentation
site_dir: html
markdown_extensions: [toc,fenced_code]
use_directory_urls: false
theme: readthedocs
extra_css: ["https://fiware.org/style/fiware_readthedocs.css", "https://www.fiware.org/style/fiware_readthedocs_processing.css"]

pages:
- 'Home': 'index.md'
- 'Architecture': 'architecture.md'
- 'Installation & Administration Manual':
- 'Introduction': 'admin.md'
- 'Configuration': 'configuration.md'
- 'Deployment': 'deployment.md'
- 'Logs': 'logs.md'
- 'User Guide':
- 'Plain Rules': 'plain_rules.md'
- 'Models': 'models.md'
- 'Actions': 'pep_actions.md'
- 'API': 'api.md'
- 'Metrics API': 'metrics_api.md'
- 'Errors': 'errors.md'