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 skeleton #127

Merged

Conversation

darrylmelander
Copy link
Collaborator

This is a start on the documentation. What's been completed so far:

  • Automatically publish to egret.readthedocs.io
  • Tweaked default layout to my liking
  • Created the documentation outline
  • Wrote a few sections:
    • Installation
    • How to run
    • Configuration Options

I think I'd like to merge what we've got so far, partly to encourage any new development to write documentation as new capabilities are added. We can continue to fill in documentation in new PRs.

Partially addresses #35

@darrylmelander darrylmelander added the documentation Improvements or additions to documentation label Dec 15, 2021
* Link to readthedocs
* Set up documentation outline/skeleton
* Write a few topics (installation, running Prescient, and configuration)
Copy link
Collaborator

@bknueven bknueven left a comment

Choose a reason for hiding this comment

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

Looks good. I think we should change the release number before merging.

doc/OnlineDocs/source/conf.py Outdated Show resolved Hide resolved
doc/OnlineDocs/source/tasks/install.rst Outdated Show resolved Hide resolved
… only, I want a separate git commit to bump the code version number)* Add copyright

* Remove reference to SCIP
Also fixed a "coming soon" that already came
@darrylmelander darrylmelander merged commit 113d79f into grid-parity-exchange:main Dec 15, 2021
@darrylmelander darrylmelander deleted the documentation_skeleton branch December 15, 2021 19:00
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants