Add documents

Signed-off-by: Hiroshi Miura <miurahr@linux.com>
This commit is contained in:
Hiroshi Miura
2019-03-23 20:21:39 +09:00
parent 45aec55ce5
commit 9802edd1b3
11 changed files with 128 additions and 8 deletions

1
.gitignore vendored
View File

@@ -7,3 +7,4 @@ __pycache__
.idea
.tox
.venv
_build

7
AUTHORS Normal file
View File

@@ -0,0 +1,7 @@
Aqtinstall is written and maintained by Hiroshi Miura <miurahr@linux.com>
Original qli-installer is written by Linus Jahn
Contributors, listed alphabetically, are:
* bra bra

View File

@@ -14,10 +14,13 @@ Current changes
Added
-----
* sphnix document.
Changed
-------
* Project directory structure.
* cli command name changed ot `aqt` and now you can run `aqt install`
Fixed
-----

40
CONTRIBUTE.rst Normal file
View File

@@ -0,0 +1,40 @@
==================
Contribution guide
==================
This is contribution guide for aqtinstall project.
You are welcome to send a Pull-Request, reporting bugs and ask questions.
Resources
=========
- Project owner: Hiroshi Miura
- Bug Tracker: Github issue `Tracker`_
- Status: alpha
- Activity: high
.. _`Tracker`: https://github.com/miurahr/aqtinstall/issues
Bug triage
==========
Every report to github issue tracker should be in triage.
whether it is bug, question or invalid.
Send patch
==========
Here is small amount rule when you want to send patch the project;
1. every proposal for modification should send as 'Pull Request'
1. each pull request can consist of multiple commits.
1. you are encourage to split modifications to individual commits that are logical subpart.
CI tests
=========
The project configured to use Azure Pipelines, Travis-CI and CoverAlls for regression test.
You can see test results on badge and see details in a web page linked from badge.

View File

@@ -97,7 +97,7 @@ Example: Show help message
.. code-block:: bash
aqt -h
aqt help

9
docs/authors.rst Normal file
View File

@@ -0,0 +1,9 @@
:tocdepth: 2
.. _authors:
aqtinstall authors
================
.. include:: ../AUTHORS

7
docs/changes.rst Normal file
View File

@@ -0,0 +1,7 @@
:tocdepth: 2
.. default-role:: any
.. _changes:
.. include:: ../CHANGELOG.rst

54
docs/cli.rst Normal file
View File

@@ -0,0 +1,54 @@
.. _string-options-ref:
*********************
Command Line Options
*********************
The CLI uses argparse to parse the command line options so the short or long versions may be used and the
long options may be truncated to the shortest unambiguous abbreviation.
.. program:: aqt
.. option:: list
list available versions (not implemented yet)
.. option:: help
show generic help
.. option:: install <Qt version> <target OS> <target variant> <target environment>
install Qt library specified version and target.
.. describe:: Qt version
This is a Qt version such as 5.9,7, 5.12.1 etc
.. describe:: target OS
linux, windows or mac
.. describe:: target variant
desktop or android
.. describe:: target environment
* gcc_64 for linux desktop
* clang_64 for mac desktip
* win64_msvc2017_64, win64_msvc2015_64, in32_msvc2015, win32_mingw53 for windows desktop
* android_x86, android_armv7 for android
.. option:: --version, -v
Display version
.. option:: --help, -h
Display help text
.. option::

View File

@@ -110,7 +110,7 @@ todo_include_todos = False
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'alabaster'
html_theme = 'sphinx_rtd_theme'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the

1
docs/devguide.rst Normal file
View File

@@ -0,0 +1 @@
.. include:: ../CONTRIBUTE.rst

View File

@@ -1,8 +1,3 @@
.. aqtinstall documentation master file, created by
sphinx-quickstart on Sat Mar 23 20:07:58 2019.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to aqtinstall's documentation!
======================================
@@ -11,7 +6,10 @@ Contents:
.. toctree::
:maxdepth: 2
cli
changes
devguide
authors
Indices and tables
==================