Skip to content

Commit

Permalink
Merge pull request #157 from uccser/issue/150
Browse files Browse the repository at this point in the history
IT'S HAPPENING!
  • Loading branch information
haydenjackson01 authored Apr 3, 2017
2 parents 06f0bfb + 648ecfd commit 3308058
Show file tree
Hide file tree
Showing 438 changed files with 771 additions and 771 deletions.
2 changes: 1 addition & 1 deletion .codeclimate.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,4 @@ ratings:
paths:
- "**.py"
exclude_paths:
- "kordac/tests/*"
- "verto/tests/*"
2 changes: 1 addition & 1 deletion .flake8
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ exclude =
docs,

# This contains tests that we don't want to check
kordac/tests,
verto/tests,

show-source = True
statistics = True
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Clearly and concisely describe the issue or suggestion here:

*Change the space in the box to an `x` for those that apply. You can also fill these out after creating the issue.*

- [ ] I have linked any relevant [existing issues/suggestions](https://github.com/uccser/kordac/issues) in the description above (include `#???` in your description to reference an issue, where `???` is the issue number)
- [ ] I have linked any relevant [existing issues/suggestions](https://github.com/uccser/verto/issues) in the description above (include `#???` in your description to reference an issue, where `???` is the issue number)

If this is a code related issue, please include the following in your description:

Expand Down
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Describe the big picture of your changes here to communicate to the maintainers
*Change the space in the box to an `x` for those that apply. You can also fill these out after creating the pull request. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your change.*

- [ ] I have read the [contribution guidelines](.github/CONTRIBUTING.md)
- [ ] I have linked any relevant [existing issues/suggestions](https://github.com/uccser/kordac/issues) in the description above (include `#???` in your description to reference an issue, where `???` is the issue number)
- [ ] I have linked any relevant [existing issues/suggestions](https://github.com/uccser/verto/issues) in the description above (include `#???` in your description to reference an issue, where `???` is the issue number)
- [ ] I have run the test suite and all tests passed
- [ ] I have added necessary documentation (if appropriate)

Expand Down
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ install:
# Runs test suite
script:
- flake8
- python -m kordac.tests.start_tests --travis
- python -m verto.tests.start_tests --travis

# Stop email notifications but post to organisation Slack channel
notifications:
Expand Down
14 changes: 7 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Contributing Guide

Welcome to the Kordac developer community! We have spent many months developing this project, and we would love for you to get involved!
Welcome to the Verto developer community! We have spent many months developing this project, and we would love for you to get involved!

We've written a technical guide about how Kordac works and how to contribute [here](kordac.readthedocs.io/en/develop/contributing.html). These docs should give you a good overview of how Kordac is pieced together.
We've written a technical guide about how Verto works and how to contribute [here](verto.readthedocs.io/en/develop/contributing.html). These docs should give you a good overview of how Verto is pieced together.

Below are a few more general notes to remember while you are working on Kordac.
Below are a few more general notes to remember while you are working on Verto.

### Code of Conduct

Expand All @@ -14,14 +14,14 @@ Please report unacceptable behavior to [csse-education-research@canterbury.ac.nz

### Reporting issues

This section guides you through submitting an issue for Kordac.
This section guides you through submitting an issue for Verto.
Following these guidelines helps maintainers and the community understand your findings.

Before submitting an issue, please take a look at the [issues](https://github.com/uccser/kordac/issues) on the repository to check it hasn't already been reported.
Before submitting an issue, please take a look at the [issues](https://github.com/uccser/verto/issues) on the repository to check it hasn't already been reported.

### Your first code contribution

Unsure where to begin contributing to Kordac? Take a look at the [issues](https://github.com/uccser/kordac/issues) on the repository.
Unsure where to begin contributing to Verto? Take a look at the [issues](https://github.com/uccser/verto/issues) on the repository.

### Pull requests

Expand All @@ -30,7 +30,7 @@ Unsure where to begin contributing to Kordac? Take a look at the [issues](https:
- Your pull request should be on a new branch from our `develop` branch (unless it's something tiny like a typo). The naming conventions of branches should be descriptive of the new addition/modification. Ideally they would specify their namespace as well, for example:
- `processor/image`
- `issue/234`
- Linked any relevant [existing issues](https://github.com/uccser/kordac/issues).
- Linked any relevant [existing issues](https://github.com/uccser/verto/issues).
- Run the test suite and all tests passed
- Added necessary documentation (if appropriate).

Expand Down
2 changes: 1 addition & 1 deletion MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
include *.txt
include *.md
recursive-include kordac *.html *.py *.png *.conf *.md *.json
recursive-include verto *.html *.py *.png *.conf *.md *.json
30 changes: 15 additions & 15 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
.. figure:: kordac/images/kordac-logo.png
:alt: Kordac Logo
.. figure:: verto/images/verto-logo.png
:alt: Verto Logo

|Build Status| |Code Climate Status|

Kordac is an extension of the Python Markdown package, which allows
Verto is an extension of the Python Markdown package, which allows
authors to include complex HTML elements with simple text tags in their
Markdown files.

Documentation
-------------

Installation and usage documentation for Kordac can be found on
Installation and usage documentation for Verto can be found on
`ReadTheDocs`_, and can also be built from the documentation source
within the ``docs/`` directory of the development distribution.

License
-------

Kordac is licensed under the MIT License. Read the `license file`_ for
Verto is licensed under the MIT License. Read the `license file`_ for
more details.

Bugs and feature requests
Expand All @@ -36,19 +36,19 @@ The changelog is available within the `documentation`_.

**How do I install the development version as local package?**

1. ``$ git clone https://github.com/uccser/kordac.git``
2. ``$ cd kordac``
1. ``$ git clone https://github.com/uccser/verto.git``
2. ``$ cd verto``
3. ``$ pip3 install .``

.. _ReadTheDocs: http://kordac.readthedocs.io/en/latest/
.. _documentation: http://kordac.readthedocs.io/en/latest/changelog.html
.. _ReadTheDocs: http://verto.readthedocs.io/en/latest/
.. _documentation: http://verto.readthedocs.io/en/latest/changelog.html
.. _license file: LICENSE.md
.. _existing and closed issues: https://github.com/uccser/kordac/issues
.. _open a new issue: https://github.com/uccser/kordac/issues/new
.. _existing and closed issues: https://github.com/uccser/verto/issues
.. _open a new issue: https://github.com/uccser/verto/issues/new

.. |Build Status| image:: https://travis-ci.org/uccser/kordac.svg?branch=master
:target: https://travis-ci.org/uccser/kordac
.. |Build Status| image:: https://travis-ci.org/uccser/verto.svg?branch=master
:target: https://travis-ci.org/uccser/verto

.. |Code Climate Status| image:: https://codeclimate.com/github/uccser/kordac/badges/gpa.svg
:target: https://codeclimate.com/github/uccser/kordac
.. |Code Climate Status| image:: https://codeclimate.com/github/uccser/verto/badges/gpa.svg
:target: https://codeclimate.com/github/uccser/verto
:alt: Code Climate
2 changes: 1 addition & 1 deletion docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SPHINXPROJ = Kordac
SPHINXPROJ = Verto
SOURCEDIR = source
BUILDDIR = build

Expand Down
2 changes: 1 addition & 1 deletion docs/make.bat
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ shift /1

set SOURCEDIR=source
set BUILDDIR=build
set SPHINXPROJ=Kordac
set SPHINXPROJ=Verto

if "%1" == "" goto help

Expand Down
14 changes: 7 additions & 7 deletions docs/source/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Fixes:
0.3.0
=======================================

Third prerelease of the Kordac converter.
Third prerelease of the Verto converter.

Adds support for the following processors:

Expand All @@ -22,14 +22,14 @@ Adds support for the following processors:

Fixes:

- Kordac now orders tags correctly in the markdown pipeline.
- System tests for multiple calls to Kordac and for multi-line templates.
- Glossary tags now correctly store slugs for the Kordac result as per documentation.
- Verto now orders tags correctly in the markdown pipeline.
- System tests for multiple calls to Verto and for multi-line templates.
- Glossary tags now correctly store slugs for the Verto result as per documentation.

0.2.0
=======================================

Second prerelease of the Kordac converter.
Second prerelease of the Verto converter.

Adds support for the following processors:

Expand All @@ -42,7 +42,7 @@ Adds basic support for Code Climate.

Fixes:

- Kordac default processors can be accessed via a static method.
- Verto default processors can be accessed via a static method.
- Required and optional arguments are now explicitly matched against input.
- Made tag parameters consistently use dashes as separators.
- Tests for previous processors now explicitly test matches.
Expand All @@ -52,7 +52,7 @@ Fixes:
0.1.0
=======================================

Initial prerelease of Kordac converter.
Initial prerelease of Verto converter.

Includes the following processors:

Expand Down
16 changes: 8 additions & 8 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
# Kordac documentation build configuration file, created by
# Verto documentation build configuration file, created by
# sphinx-quickstart on Mon Jan 30 17:06:19 2017.
#
# This file is execfile()d with the current directory set to its
Expand All @@ -20,7 +20,7 @@
import os
import sys
sys.path.insert(0, os.path.abspath('../../'))
from kordac import __version__
from verto import __version__


# -- General configuration ------------------------------------------------
Expand All @@ -47,7 +47,7 @@
master_doc = 'index'

# General information about the project.
project = 'Kordac'
project = 'Verto'
copyright = '2017 University of Canterbury Computer Science Education Research Group'
author = 'Hayley vas Waas, Jack Morgan, Hayden Jackson, Jordan Griffiths'

Expand Down Expand Up @@ -103,7 +103,7 @@
# -- Options for HTMLHelp output ------------------------------------------

# Output file base name for HTML help builder.
htmlhelp_basename = 'Kordacdoc'
htmlhelp_basename = 'Vertodoc'


# -- Options for LaTeX output ---------------------------------------------
Expand All @@ -130,7 +130,7 @@
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'Kordac.tex', 'Kordac Documentation',
(master_doc, 'Verto.tex', 'Verto Documentation',
'Hayley vas Waas, Jack Morgan', 'manual'),
]

Expand All @@ -140,7 +140,7 @@
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'kordac', 'Kordac Documentation',
(master_doc, 'verto', 'Verto Documentation',
[author], 1)
]

Expand All @@ -151,7 +151,7 @@
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'Kordac', 'Kordac Documentation',
author, 'Kordac', 'One line description of project.',
(master_doc, 'Verto', 'Verto Documentation',
author, 'Verto', 'One line description of project.',
'Miscellaneous'),
]
Loading

0 comments on commit 3308058

Please sign in to comment.