Skip to content

Commit

Permalink
Fixed documentation on RTD
Browse files Browse the repository at this point in the history
  • Loading branch information
RaphaelRobidas committed Jan 17, 2022
1 parent dc5c2dd commit 01aef2e
Show file tree
Hide file tree
Showing 6 changed files with 23 additions and 13 deletions.
7 changes: 6 additions & 1 deletion .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,13 @@ build:
python: "3.9"

sphinx:
configuration: docs/conf.py
configuration: docs/source/conf.py
fail_on_warning: true

python:
system_packages: true
install:
- requirements: docs/requirements.txt
- requirements: requirements.txt
- method: setuptools
path: .
File renamed without changes.
9 changes: 5 additions & 4 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
import sys
import os
from os.path import basename
from pathlib import Path

sys.path.insert(0, os.path.abspath('../..'))

project = 'ccinput'
copyright = '2022, Raphaël Robidas'
Expand All @@ -24,21 +27,18 @@
'python': ('https://docs.python.org/3/', None),
'sphinx': ('https://www.sphinx-doc.org/en/master/', None),
}

intersphinx_disabled_domains = ['std']

templates_path = ['_templates']

exclude_patterns = []

html_static_path = ['_static']

html_theme = 'sphinx_rtd_theme'

epub_show_urls = 'footnote'
autosectionlabel_prefix_document = True

# Add the package's dir to the path in order to load it without installation
sys.path.append(os.path.join(os.path.dirname(__file__), '../..'))

# The following code is a "trick" to be able to dynamically create some parts of the documentation
# https://stackoverflow.com/a/29789910/9796543
Expand Down Expand Up @@ -76,3 +76,4 @@ def run(self):

def setup(app):
app.add_directive('exec', ExecDirective)

3 changes: 2 additions & 1 deletion docs/source/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,13 @@ The parameters to these two wrappers will be the same as in the command line usa
Parameter Details
------------------

Basis sets are not case sensitive and ``ccinput`` recognizes several synonyms for each of them. For example, "Def2-TZVP" can be written in any of these forms:
The parameters not case sensitive and ``ccinput`` recognizes several synonyms for each of them. For example, "Def2-TZVP" can be written in any of these forms:

- def2-TZVP
- DEF2TZVP
- def2tzvp

The accepted synonyms will be listed for each parameter. If you believe that a common or useful synonym is missing, feel free to send a pull request.

Software
^^^^^^^^
Expand Down
1 change: 0 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,5 @@
requires = [
"setuptools>=42",
"wheel",
"versioneer"
]
build-backend = "setuptools.build_meta"
16 changes: 10 additions & 6 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
periodictable
basis_set_exchange
numpy
coverage
nose
versioneer
argcomplete==2.0.0
attrs==21.4.0
basis-set-exchange==0.9
jsonschema==4.4.0
numpy==1.22.1
periodictable==1.6.0
pyparsing==3.0.6
pyrsistent==0.18.1
regex==2021.11.10
versioneer==0.21

0 comments on commit 01aef2e

Please sign in to comment.