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

Remove old docs #261

Closed
rotu opened this issue Sep 29, 2023 · 1 comment
Closed

Remove old docs #261

rotu opened this issue Sep 29, 2023 · 1 comment

Comments

@rotu
Copy link
Contributor

rotu commented Sep 29, 2023

Right now, the master branch has a copy of the docs per version. This is a pain because doing a naive search in the source tree brings up duplicate results (some outdated). I suspect the reason for this is because the docs subdirectory is being served at https://docs.vectorious.org/ (which, incidentally, also lacks an index page).

If the docs are to be included in the source tree, they should be at an unchanging path so they can be meaningfully blame-d and diff-ed.

@mateogianolio
Copy link
Owner

Agreed, the docs are a pain atm. I have made an effort to move all docs to sphinx, if you check out the sphinx branch you can try it out with:

cd docs
pip install -r requirements.txt
make html
# builds html files in docs/_build

I still haven't figured out how to deploy it to github pages without having a copy of it in the master branch.

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

No branches or pull requests

2 participants