Skip to content

Commit

Permalink
added the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
mohammedazzouzi15 committed Sep 19, 2024
1 parent a7e2e24 commit adfe670
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 1 deletion.
24 changes: 24 additions & 0 deletions .github/workflows/sphinx.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: "Sphinx: Render docs"

on: push

jobs:
build:
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- uses: actions/checkout@v4
- name: Build HTML
uses: ammaraskar/sphinx-action@master
- name: Upload artifacts
uses: actions/upload-artifact@v4
with:
name: html-docs
path: docs/build/html/
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
if: github.ref == 'refs/heads/main'
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/build/html
2 changes: 2 additions & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
sphinx==7.1.2
sphinx-rtd-theme==1.3.0rc1
furo==2021.11.16

2 changes: 1 addition & 1 deletion src/stk_search/utils/Precursor_calculation.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
import stk
import stko

from stk_search.ObjectiveFunctions.ObjectiveFunction import IpEs1Fosc
from stk_search.ObjectiveFunctions.IpEs1Fosc import IpEs1Fosc


def get_inchi_key(molecule)->str:
Expand Down

0 comments on commit adfe670

Please sign in to comment.