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

Use Sphinx to create awesome documentation for the project #131

Open
mithro opened this issue Feb 3, 2022 · 2 comments
Open

Use Sphinx to create awesome documentation for the project #131

mithro opened this issue Feb 3, 2022 · 2 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@mithro
Copy link
Author

mithro commented Feb 3, 2022

@umarcor might also be able to provide some tips and pointers.

@umarcor
Copy link

umarcor commented Feb 3, 2022

We use BuildTheDocs in many projects. It's a Python script (https://github.com/buildthedocs/btd/blob/master/btd/__init__.py) available as a GitHub Action (https://github.com/buildthedocs/btd/blob/master/action.yml), which can be used in a workflow as follows:

      - name: '📓 BuildTheDocs (BTD)'
        uses: buildthedocs/btd@v0
        with:
          token: ${{ github.token }}
          skip-deploy: github.event_name == 'pull_request'

It builds the docs and pushes them to GitHub Pages (branch gh-pages).

For reference, see the .btd.yml, doc/conf.py and doc/Makefile files in any of the repos from github.com/edaa-org.

@donn donn added documentation Improvements or additions to documentation enhancement New feature or request labels Feb 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants