Skip to content
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

Docs on gh-pages #16

Merged
merged 3 commits into from
Mar 18, 2020
Merged

Docs on gh-pages #16

merged 3 commits into from
Mar 18, 2020

Conversation

alecandido
Copy link
Member

Fix gh-pages docs deployment workflow.

Brief description of the workflow:

  1. checkout the repo and eko submodule
  2. install eko and its dependencies
  3. install the module
  4. build the docs with sphinx
  5. deploy to gh-pages branch only the built html

@alecandido
Copy link
Member Author

Docs currently available at address:

https://n3pdf.github.io/dis/

@alecandido alecandido merged commit c56552c into master Mar 18, 2020
@alecandido
Copy link
Member Author

Improvements

Further improvements available:

  • remove sphinx from install requirements:
install_requires=[
    ...,
    "sphinx_rtd_theme",
    "recommonmark",
    "sphinxcontrib-bibtex",
]

probably a good way to run sphinx can be from its setuptools integration

  • simplify eko dependency (this will be easily done once a version of eko will be deployed on PyPI or anywhere)
    • document in eko the dependency on libgsl-dev

Pytest

Even if it is not related to this workflow, just to document 📄 it somewhere:

  • introduce a pytest requirement in tests_require

@alecandido alecandido deleted the dev-ghpages-workflow branch March 18, 2020 11:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant