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

Merge doc makefiles into a Python script #96

Open
datapythonista opened this issue Aug 5, 2019 · 9 comments
Open

Merge doc makefiles into a Python script #96

datapythonista opened this issue Aug 5, 2019 · 9 comments

Comments

@datapythonista
Copy link
Member

In the doc/ directory we've got two different scripts, that were created by Sphinx, Makefile and make.bat. The reason why Sphinx does this is because a Makefile only works in unix system (Linux or Mac mainly), so a separate make.bat file to build the docs in windows is provided.

But instead of having two separate scripts, seems more efficient to have a single script in a language that works in any platform. Python looks like a good option for that. Can we replace those files by a Python file that builds the documentation and provides the same functionality?

@Ayowolet
Copy link
Member

Ayowolet commented Aug 5, 2019

I'll take this one

@sparalic
Copy link
Member

sparalic commented Aug 8, 2019

@Ayowolet do you need help with this issue?

@Ayowolet
Copy link
Member

Ayowolet commented Aug 8, 2019

@sparalic no thank you... was distracted by the azure pipelines...

@Ayowolet
Copy link
Member

@datapythonista I'm struggling with this a little bit. Can I use the make.py file in the pandas repository as a guide?

@datapythonista
Copy link
Member Author

Absolutely, we need something much simpler here, but everything we need should be in that file.

Feel free to open a PR that is not finished/not working, so people can have a look and help you.

@Ayowolet
Copy link
Member

Okay, thanks. I will do that.

@Ayowolet
Copy link
Member

I've taken too long on this.. @sparalic if you want to work on this, please feel free.. I've not been able to devote as much time as I ought to.. @datapythonista I apologise for spending too long

@sparalic
Copy link
Member

@Ayowolet sure I can help you with this one. @datapythonista do you want this copied over from the pandas repo, or should I use that as a working doc and retrofit it to our needs?

@datapythonista
Copy link
Member Author

The pandas one is very complex. You can use it for inspiration, but I'd just create a very simple one with what the script are doing now, but in Python, so a single script work in any OS.

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

3 participants