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

Documentation: Add initial docs setup #31

Merged
merged 8 commits into from
Dec 1, 2024

Conversation

activus-d
Copy link
Collaborator

@activus-d activus-d commented Nov 9, 2024

This pull request adds documentation setup, including a GitHub Actions workflow to build it.

I've modified the docs/Makefile to use sphinx-autobuild, which watches for changes in the source documentation files:

# Start a local development server to automatically rebuild and serve the HTML documentation 
# whenever changes are made to the source files.
run:
	sphinx-autobuild "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

Also, I've added instructions for building the documentation locally in django-otp-webauthn/DEVELOPMENT.md.

Copy link

codecov bot commented Nov 9, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.0%. Comparing base (5e741ba) to head (9e04b54).
Report is 49 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##            main      #31      +/-   ##
=========================================
+ Coverage   83.4%   100.0%   +16.5%     
=========================================
  Files         13       13              
  Lines        683      683              
  Branches      57       56       -1     
=========================================
+ Hits         570      683     +113     
+ Misses       111        0     -111     
+ Partials       2        0       -2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@activus-d activus-d requested a review from Stormheg November 9, 2024 09:31
Copy link
Member

@Stormheg Stormheg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good progress! Thanks for working on this @activus-d and your help in setting this up ❤️

I've left a couple suggestions. One other request that I have is if it is possible to show an 'edit on github' link like shown in the top-right corner here: https://django-tables2.readthedocs.io/en/latest/

I sometimes use such links to quickly go and propose fixes for minor things like typos. Saves me time looking for the right file to edit.

DEVELOPMENT.md Show resolved Hide resolved
docs/requirements.txt Outdated Show resolved Hide resolved
docs/requirements.txt Outdated Show resolved Hide resolved
docs/index.rst Outdated Show resolved Hide resolved
docs/conf.py Outdated Show resolved Hide resolved
docs/conf.py Outdated Show resolved Hide resolved
docs/conf.py Outdated Show resolved Hide resolved
Comment on lines 39 to 44
- name: Upload documentation artifacts
uses: actions/upload-artifact@v4
with:
name: sphinx-docs
path: docs/_build/html/ # Updated path to reflect docs directory
retention-days: 7
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@activus-d don't we need to make the documentation available somewhere? Or did you consider that out of scope for this PR?

If it helps, I registered with ReadTheDocs and connected this repository, in case we wanted to host the docs with them.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, the docs would be deployed, and I can make a pull request or push a new commit to set up deployment to ReadTheDocs once you’re cool with the initial configuration and setup here. Let me know your thoughts!

@Stormheg
Copy link
Member

@activus-d for the check errors, you can install and use pre-commit which will perform validity checks on the files you changed when you are creating a git commit out of your changes. See the instructions in DEVELOPMENT.md

move content of requirements.txt to docs group in pyproject.toml;
Add temporary content to index.rst for testing;
Update conf.py with GitHub star button and correct author
Copy link
Member

@Stormheg Stormheg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great to me!

@Stormheg Stormheg merged commit a7cfdfa into Stormbase:main Dec 1, 2024
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants