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.

Sign up for GitHub

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

Jump to bottom

Inkgd docs: Add Sphinx initial files. These files are necessary to setup a document in Sphinx. This will be later used in ReadTheDocs: https://inkgd.readthedocs.io/ #42

Merged
merged 2 commits into from
Nov 14, 2021
Merged

Inkgd docs: Add Sphinx initial files. These files are necessary to setup a document in Sphinx. This will be later used in ReadTheDocs: https://inkgd.readthedocs.io/ #42

merged 2 commits into from
Nov 14, 2021

Conversation

videlanicolas
Copy link
Contributor

No description provided.

@videlanicolas
Inkgd docs: Add Sphinx initial files.
3ec90f8 
These files are necessary to setup a document in Sphinx.
This will be later used in ReadTheDocs: https://inkgd.readthedocs.io/
@videlanicolas
Copy link
Contributor Author

#41

ephread
ephread reviewed Nov 14, 2021
View reviewed changes
Copy link
Owner

@ephread ephread left a comment

Choose a reason for hiding this comment

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

LGTM!

I just have a question regarding make.bat, as someone who has never used Sphinx before. Isn't that file windows-only? How does the whole system behave on Linux and macOS?

@videlanicolas
Change master for main.
4f482c2 
There's no master branch in this repo.
@videlanicolas
Copy link
Contributor Author

Isn't that file windows-only?

This was automatically generated by Sphinx, but my understanding is that the command make html should work out of the box on any OS. make.bat will run on Windows systems and makefile will run on Linux and macOS.

@ephread ephread self-requested a review November 14, 2021 22:36
@ephread
Copy link
Owner

ephread commented Nov 14, 2021

make.bat will run on Windows systems and makefile will run on Linux and macOS.

Makes total sense, I hadn't realised makefile and make.bat served the same purpose. 🤦
Thanks for the explanation, merging now!

@ephread ephread merged commit 69561b1 into ephread:main Nov 14, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ephread ephread ephread approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@videlanicolas @ephread