Skip to content

Fix for documentation creation #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
May 8, 2024
4 changes: 2 additions & 2 deletions .github/workflows/documentation-build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,11 @@ jobs:
- name: Install Pandoc, repo and dependencies
run: |
sudo apt install pandoc
pip install . '.[docs]'
pip install . '.[dev,docs]'
- name: Build and Commit
uses: sphinx-notes/pages@master
with:
install_requirements: true
install_requirements: false
documentation_path: docs/src
- name: Push changes
uses: ad-m/github-push-action@master
Expand Down
15 changes: 9 additions & 6 deletions docs/src/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,21 +19,22 @@
#
import os
import sys
import toml
# import toml
from pathlib import Path
import easyscience
# sys.path.insert(0, os.path.abspath('.'))
main_root = Path(__file__).parents[2]
sys.path.append(str(main_root))

import datetime

project_info = toml.load(os.path.join(main_root, 'pyproject.toml'))
# project_info = toml.load(os.path.join(main_root, 'pyproject.toml'))

# -- Project information -----------------------------------------------------

project = 'EasyScience'
copyright = f"{datetime.date.today().year}, EasyReflectometry"
author = "EasyReflectometry"
copyright = f"{datetime.date.today().year}, EasyScience Contributors"
author = "EasyScience Contributors"
# copyright = f"2021, {project_info['tool']['poetry']['authors'][0]}"
# author = project_info['tool']['poetry']['authors'][0]

Expand All @@ -42,9 +43,11 @@
# # The full version, including alpha/beta/rc tags
# release = project_info['tool']['poetry']['version']
# The short X.Y version.
version = project_info['project']['version']
#version = project_info['project']['version']
# The full version, including alpha/beta/rc tags.
version = project_info['project']['version']
#version = project_info['project']['version']
version = easyscience.__version__


intersphinx_mapping = {
'python': ('https://docs.python.org/3', None),
Expand Down
Loading