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

Add developer starting guide into the docs #133

Open
spisakt opened this issue Dec 19, 2022 · 0 comments
Open

Add developer starting guide into the docs #133

spisakt opened this issue Dec 19, 2022 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@spisakt
Copy link
Member

spisakt commented Dec 19, 2022

The documentation is sphinx-based and gets automatically render by ReadtheDocs.io.

Make a new "menu point" in Docs/index.rst, called "Developer guide".
This points to a new file, which will describe various options in the future.
Copy your pycharm+Docker sop there.

The doc pages already contains a small description about how to do it:

https://pumi.readthedocs.io/en/docs-test/dev_docs.html

Refer to the sphinx user guide for more details (e.g. how to render the docs locally for testing, how to upload images, etc.).

@spisakt spisakt added the documentation Improvements or additions to documentation label Dec 19, 2022
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

No branches or pull requests

2 participants