Skip to content

Commit

Permalink
add initial documentation setup with index and release_notes
Browse files Browse the repository at this point in the history
  • Loading branch information
Saurabh Kumar committed Feb 8, 2015
1 parent f46972e commit 6da6e9f
Show file tree
Hide file tree
Showing 6 changed files with 55 additions and 1 deletion.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -77,3 +77,4 @@ debug.log
# Node modules & bower components
junction/static/node_modules/
junction/static/bower_components/
_docs_html/
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,10 @@ junction
========

[![Build Status](https://travis-ci.org/pythonindia/junction.svg)](https://travis-ci.org/pythonindia/junction) [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/pythonindia/junction?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

<!-- fix to mkdocs display these badges correctly -->
<style>
div.col-md-9 img {display: inline-block; padding: 0; border: none; border-radius: 0; margin: 0;}
</style>

Junction is a software to manage proposals, reviews, schedule, feedback during conference.

Expand Down
1 change: 1 addition & 0 deletions docs/index.md
30 changes: 30 additions & 0 deletions docs/release_notes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Release Notes

## [0.2.0]

- ...

## [0.1.0]

[Under Development]

- initial release with core functionality working

[0.2.0]: https://github.com/pythonindia/junction/issues?q=milestone%3A%22release+0.2.0%22
[0.1.0]: https://github.com/pythonindia/junction/issues?q=milestone%3A%22release+0.1.0+-+initial+release%22

<!-- autolinks #12 to an github issue -->
<script src="https://padolsey.github.io/findAndReplaceDOMText/src/findAndReplaceDOMText.js"></script>
<script>
var repo = 'pythonindia/junction';
findAndReplaceDOMText(document.querySelector('[role="main"]'), {
find: /#(\d+)/g,
replace: function(portion, match){
var el = document.createElement("a");
el.setAttribute('href', 'http://github.com/'+ repo +'/issues/'+ match[1]);
el.setAttribute('target', '_blank');
el.innerHTML = portion.text;
return el;
}
});
</script>
15 changes: 15 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# see: https://github.com/tomchristie/mkdocs/blob/master/mkdocs.yml
site_name: Junction
site_description: Junction is a software to manage proposals, reviews, schedule, feedback during conference.
theme: 'mkdocs'
theme_center_lead: false
repo_url: https://github.com/pythonindia/junction

pages:
- ['index.md', 'Home']
- ['release_notes.md', 'Release Notes']

copyright: Copyright &copy; 2015, <a href="http://pssi.org.in" title="Python Software Society of India">PSSI</a>.

# directory to output HTML build
site_dir: _docs_html
4 changes: 4 additions & 0 deletions requirements-dev.txt
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,7 @@ pytest-pythonpath==0.3
pytest-ipdb==0.1-prerelease2

coverage==3.7.1

# Documentation
# --------------------------------------------------
mkdocs==0.11.1

0 comments on commit 6da6e9f

Please sign in to comment.