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

Init documentation website #20

Merged
merged 5 commits into from
Jan 18, 2023
Merged

Init documentation website #20

merged 5 commits into from
Jan 18, 2023

Conversation

ffelten
Copy link
Collaborator

@ffelten ffelten commented Jan 17, 2023

Based on Farama template.

I initiated some pages but did not clean everything. I'm wondering how to avoid duplicating the README vs the website.

Testing

pip install . 
cd docs/
pip install -r docs/requirements.txt
make dirhtml _build

Open the docs/build/dirhtml/index.html using a browser

@ffelten
Copy link
Collaborator Author

ffelten commented Jan 17, 2023

I see this when I click on the side menu:
image

@ffelten ffelten marked this pull request as draft January 18, 2023 10:34
Copy link
Contributor

@mgoulao mgoulao left a comment

Choose a reason for hiding this comment

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

Building:

make dirhtml
python -m http.server  --directory _build

OR:

sphinx-autobuild -b dirhtml . _build

docs/conf.py Outdated Show resolved Hide resolved
docs/conf.py Outdated Show resolved Hide resolved
docs/environments/environments.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
@ffelten ffelten marked this pull request as ready for review January 18, 2023 12:28
@ffelten ffelten merged commit b254b14 into main Jan 18, 2023
@ffelten ffelten deleted the doc/init-website branch January 18, 2023 12:34
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.

None yet

2 participants