pyscf / pyscf/pyscf.github.io

Entry to api doc

Open
#137 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TeX
Stars
41
Forks
88
Avg merge
8d 9h
Merged PRs (30d)
3

Description

Looks like there's no entry to api doc after the new theme applied (#133), although the former url (https://pyscf.org/pyscf_api_docs/pyscf.html) of api doc is still accessible. Should it be added back (in the index page or contributor guide)?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Check the documentation index page and contributor guide against the still-accessible API documentation at https://pyscf.org/pyscf_api_docs/pyscf.html. Determine the appropriate entry point, add a link where it belongs, and verify that the API documentation is reachable from the updated page.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.