Commit Graph

9 Commits

Author SHA1 Message Date
Thomas Holder
578b57694f propka3 --version prints version
Closes https://github.com/jensengroup/propka/issues/89
2020-12-09 10:19:54 -07:00
IAlibay
196a2c6a1f remove unused command 2020-11-18 01:13:59 +00:00
Oliver Beckstein
cb65c644c6 use versioneer for version management (#88)
- fix #87
- user versioneer for version management
   - use tag "vMAJOR.MINOR.PATCH" to indicate release number
   - exclude generated files from coverage;
      also exclude tests from coverage reporting;
      allow use of "# pragma: no cover" to exclude lines of code
      from coverage
   - configure coverage with entries in setup.cfg (removed
      commandline config from workflows/python-package.yml)
- related doc updates
   - make docs automatically use current version
      (docs use versioneer-based propka.__version__)
   - also added @IAlibay to authors (forgotten in previous
      PRs #84 and #85)
   - generate a sitemap (add sphinx_sitemap to requirements.txt)
- add test_version
   Note: Versioneer-generated version is “0-untagged” on the branch where
   it is tested so need to add it to a valid result.
2020-07-18 12:32:25 -07:00
Irfan Alibay
7563a706cf fixes run's single method (#85)
* Fixes #82
* Changes:
    * input arguments now reflects the changes made to read_molecule_file in #84
    * Writing of pKa file is now optional (default behaviour has been kept). This will be particularly 
       useful downstream where we would just want to have access to the MoleculeContainer object.
     * new test_run file specific for testing run.
* add tests
* add docs
2020-07-17 11:18:07 -07:00
Oliver Beckstein
02a0cbd58b link to the propka3 command page 2020-06-19 22:04:05 -07:00
Oliver Beckstein
1c343a7d96 basic usage for propka3 command 2020-06-19 21:38:45 -07:00
Oliver Beckstein
26a5ab042e API docs for propka
- use autosummary (with custom module template)
- updated module docs for all modules so that they are included
  with sphinx autodocs
2020-06-19 16:25:24 -07:00
Oliver Beckstein
65856b39fb use autosummary to generate most of the API Reference
- custom _template/autosummary/module.rst to include docs
  for all module :members" (shows up directly after the summary
  tables)
- module docs should *not* contain autodocs for members, only general
  descriptions and examples
- all files inside api/ are autogenerated whenever sphinx is run
  (no need to add to the repository, hence excluded in .gitignore)
2020-06-19 15:18:04 -07:00
Oliver Beckstein
2bf031fd65 initial sphinx docs
starts #69

- basic structure
- RTD theme
- installation
- quickstart (more to do)
- references
- added start page with license and links to repo and issues
- authors in docs: papers and repo contributors (to be discussed)
2020-06-19 12:13:53 -07:00