Documentation staging #467
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Adjusted the CLI section to include direction for Windows users, output examples, and various typos. Updated the available datasets listed.
Replacing the docs directory with files for Sphinx documentation site. Updated the usage, datasets, landing page, and added header image.
Updated conf.py to include baseurl. Small changes to documents and included pictures as jpg.
Added code to publish documentation site.
Adding code to publish docu site.
Deleted build dir and included index.html in docs dir.
Including files so the site will render properly
Moving the static file so that css files can be accessed.
Created new dir for images and updated path in yml
Copying the make.bat and Makefile to the root directory for the sphinx build command.
Add step to install dependencies from requirements.txt
Explicitly writing the sphinx build command within the steps
Explicitly writing the source directory
Including sphinx version to Build HTML step
Using a different sphinx build command
Changing to source_suffix from a list to a dict
Updating the requirements.txt file path and adding the back sphinx-notes/pages@v3
Using only peaceiris/actions-gh-pages@v3 to deploy.
Not including coderdata import.
added code to debug
Now triggers on pushes to the documentation-staging branch and deploys to the gh-pages branch.
Adding to conf.py for the API documentation, deleted unneeded files, updated the README, and added to conf.py for notebook to html conversions.
Added to file so API reference to create documentation for all the functions.
Updates to conf.py, added the tutorial notebook, and added packages to requirements.txt.
Added new tutorial and adjusted how the tutorial is displayed on the site. Added new functions from stats.py. Updated the README and requirements to reflect changes.
Install Pandoc in the yml file to correctly convert .ipynb to html.
…io/coderdata into dataset_documentation
… documentation-staging Pulling changes from main so documentation can be updated all at once.
Dataset documentation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.