Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 11 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
# Yaydoc
<code># Yaydoc</code><br>
Development [![Build Status](https://travis-ci.org/fossasia/yaydoc.svg?branch=development)](https://travis-ci.org/fossasia/yaydoc)
Master [![Build Status](https://travis-ci.org/fossasia/yaydoc.svg?branch=master)](https://travis-ci.org/fossasia/yaydoc)
[![Join the chat at https://gitter.im/fossasia/yaydoc](https://badges.gitter.im/fossasia/yaydoc.svg)](https://gitter.im/fossasia/yaydoc?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

Yaydoc is an automated documentation generation and deployment project that generates documentation for its registered repositories on each commit and deploys it to Github Pages.

## Communication
<code>## Communication</code>
- Please join our mailing list to discuss questions regarding the project: https://groups.google.com/forum/#!forum/yaydoc
- Our chat channel is on Gitter here: [gitter.im/fossasia/yaydoc](http://gitter.im/fossasia/yaydoc)

## Deployments
<code>## Deployments</code>

* Master Branch can be tested on [yaydoc.herokuapp.com](https://yaydoc.herokuapp.com/)
* Development Branch is deployed [yaydoc-dev.herokuapp.com](https://yaydoc.herokuapp.com/)

## Getting started
<code>## Getting started</code>

### Prerequisites
<code>### Prerequisites</code>
To start using Yaydoc, make sure you have all of the following:
- [GitHub](https://github.com) login
- Project [hosted as a repository](https://help.github.com/categories/importing-your-projects-to-github/) on GitHub
Expand All @@ -25,7 +25,7 @@ To start using Yaydoc, make sure you have all of the following:
> __Note:__ For advanced configurations, include an `index.rst` file which contains
[toctrees](http://www.sphinx-doc.org/en/stable/markup/toctree.html) to link the various documents.

### To get started with Yaydoc
<code>### To get started with Yaydoc</code>
1. Using your Github account, sign in to [yaydoc.org](http://yaydoc.org) and accept the Github
[access permissions confirmation](docs/user_manual/github-oauth-scopes.md)
2. Once you’re signed in to Yaydoc, go to your dashboard and register the repository you want to build your
Expand All @@ -34,7 +34,7 @@ documentation from.
4. Add the `.yaydoc.yml` file to git, commit and push, to trigger the Yaydoc build process.
5. Check the logs for your repository to see if the documentation generation and deployment process passes or fails.

### Installation
<code>### Installation</code>

1. [Local Installation](docs/installation/docs.md)
2. [Heroku](docs/installation/heroku.md)
Expand All @@ -44,16 +44,15 @@ documentation from.
> __Note:__ Yaydoc only runs builds on the commits you push after you’ve registered your repository in Yaydoc. Ensure
that the repository is enabled from the its settings at Yaydoc.

## Known limitations
<code>## Known limitations</code>
- If you use embedded html in markdown or reStructuredText, any static content such as images, javascript referred from it should be present in a `_static` directory placed under **source**.

## Deployment
[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)
<code>## Deployment</code><br>[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)

## Contributions, Bug Reports, Feature Requests
<code>## Contributions, Bug Reports, Feature Requests</code>
This is an Open Source project and we would be happy to see contributors who report bugs and file feature requests
submitting pull requests as well. Please report issues here https://github.com/fossasia/yaydoc/issues

## License
<code>## License</code>
This project is currently licensed under the GNU General Public License v3. A copy of LICENSE.md should be present
along with the source code. To obtain the software under a different license, please contact [FOSSASIA](http://blog.fossasia.org/contact/).